imports86 files
contracts/lib/openzeppelin-contracts/contracts/token/ERC20/extensions/IERC20Metadata.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity >=0.6.2;
import {IERC20} from "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC-20 standard.
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}
contracts/lib/v4-core/src/interfaces/IPoolManager.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
import {Currency} from "../types/Currency.sol";
import {PoolKey} from "../types/PoolKey.sol";
import {IHooks} from "./IHooks.sol";
import {IERC6909Claims} from "./external/IERC6909Claims.sol";
import {IProtocolFees} from "./IProtocolFees.sol";
import {BalanceDelta} from "../types/BalanceDelta.sol";
import {PoolId} from "../types/PoolId.sol";
import {IExtsload} from "./IExtsload.sol";
import {IExttload} from "./IExttload.sol";
import {ModifyLiquidityParams, SwapParams} from "../types/PoolOperation.sol";
/// @notice Interface for the PoolManager
interface IPoolManager is IProtocolFees, IERC6909Claims, IExtsload, IExttload {
/// @notice Thrown when a currency is not netted out after the contract is unlocked
error CurrencyNotSettled();
/// @notice Thrown when trying to interact with a non-initialized pool
error PoolNotInitialized();
/// @notice Thrown when unlock is called, but the contract is already unlocked
error AlreadyUnlocked();
/// @notice Thrown when a function is called that requires the contract to be unlocked, but it is not
error ManagerLocked();
/// @notice Pools are limited to type(int16).max tickSpacing in #initialize, to prevent overflow
error TickSpacingTooLarge(int24 tickSpacing);
/// @notice Pools must have a positive non-zero tickSpacing passed to #initialize
error TickSpacingTooSmall(int24 tickSpacing);
/// @notice PoolKey must have currencies where address(currency0) < address(currency1)
error CurrenciesOutOfOrderOrEqual(address currency0, address currency1);
/// @notice Thrown when a call to updateDynamicLPFee is made by an address that is not the hook,
/// or on a pool that does not have a dynamic swap fee.
error UnauthorizedDynamicLPFeeUpdate();
/// @notice Thrown when trying to swap amount of 0
error SwapAmountCannotBeZero();
///@notice Thrown when native currency is passed to a non native settlement
error NonzeroNativeValue();
/// @notice Thrown when `clear` is called with an amount that is not exactly equal to the open currency delta.
error MustClearExactPositiveDelta();
/// @notice Emitted when a new pool is initialized
/// @param id The abi encoded hash of the pool key struct for the new pool
/// @param currency0 The first currency of the pool by address sort order
/// @param currency1 The second currency of the pool by address sort order
/// @param fee The fee collected upon every swap in the pool, denominated in hundredths of a bip
/// @param tickSpacing The minimum number of ticks between initialized ticks
/// @param hooks The hooks contract address for the pool, or address(0) if none
/// @param sqrtPriceX96 The price of the pool on initialization
/// @param tick The initial tick of the pool corresponding to the initialized price
event Initialize(
PoolId indexed id,
Currency indexed currency0,
Currency indexed currency1,
uint24 fee,
int24 tickSpacing,
IHooks hooks,
uint160 sqrtPriceX96,
int24 tick
);
/// @notice Emitted when a liquidity position is modified
/// @param id The abi encoded hash of the pool key struct for the pool that was modified
/// @param sender The address that modified the pool
/// @param tickLower The lower tick of the position
/// @param tickUpper The upper tick of the position
/// @param liquidityDelta The amount of liquidity that was added or removed
/// @param salt The extra data to make positions unique
event ModifyLiquidity(
PoolId indexed id, address indexed sender, int24 tickLower, int24 tickUpper, int256 liquidityDelta, bytes32 salt
);
/// @notice Emitted for swaps between currency0 and currency1
/// @param id The abi encoded hash of the pool key struct for the pool that was modified
/// @param sender The address that initiated the swap call, and that received the callback
/// @param amount0 The delta of the currency0 balance of the pool
/// @param amount1 The delta of the currency1 balance of the pool
/// @param sqrtPriceX96 The sqrt(price) of the pool after the swap, as a Q64.96
/// @param liquidity The liquidity of the pool after the swap
/// @param tick The log base 1.0001 of the price of the pool after the swap
/// @param fee The swap fee in hundredths of a bip
event Swap(
PoolId indexed id,
address indexed sender,
int128 amount0,
int128 amount1,
uint160 sqrtPriceX96,
uint128 liquidity,
int24 tick,
uint24 fee
);
/// @notice Emitted for donations
/// @param id The abi encoded hash of the pool key struct for the pool that was donated to
/// @param sender The address that initiated the donate call
/// @param amount0 The amount donated in currency0
/// @param amount1 The amount donated in currency1
event Donate(PoolId indexed id, address indexed sender, uint256 amount0, uint256 amount1);
/// @notice All interactions on the contract that account deltas require unlocking. A caller that calls `unlock` must implement
/// `IUnlockCallback(msg.sender).unlockCallback(data)`, where they interact with the remaining functions on this contract.
/// @dev The only functions callable without an unlocking are `initialize` and `updateDynamicLPFee`
/// @param data Any data to pass to the callback, via `IUnlockCallback(msg.sender).unlockCallback(data)`
/// @return The data returned by the call to `IUnlockCallback(msg.sender).unlockCallback(data)`
function unlock(bytes calldata data) external returns (bytes memory);
/// @notice Initialize the state for a given pool ID
/// @dev A swap fee totaling MAX_SWAP_FEE (100%) makes exact output swaps impossible since the input is entirely consumed by the fee
/// @param key The pool key for the pool to initialize
/// @param sqrtPriceX96 The initial square root price
/// @return tick The initial tick of the pool
function initialize(PoolKey memory key, uint160 sqrtPriceX96) external returns (int24 tick);
/// @notice Modify the liquidity for the given pool
/// @dev Poke by calling with a zero liquidityDelta
/// @param key The pool to modify liquidity in
/// @param params The parameters for modifying the liquidity
/// @param hookData The data to pass through to the add/removeLiquidity hooks
/// @return callerDelta The balance delta of the caller of modifyLiquidity. This is the total of both principal, fee deltas, and hook deltas if applicable
/// @return feesAccrued The balance delta of the fees generated in the liquidity range. Returned for informational purposes
/// @dev Note that feesAccrued can be artificially inflated by a malicious actor and integrators should be careful using the value
/// For pools with a single liquidity position, actors can donate to themselves to inflate feeGrowthGlobal (and consequently feesAccrued)
/// atomically donating and collecting fees in the same unlockCallback may make the inflated value more extreme
function modifyLiquidity(PoolKey memory key, ModifyLiquidityParams memory params, bytes calldata hookData)
external
returns (BalanceDelta callerDelta, BalanceDelta feesAccrued);
/// @notice Swap against the given pool
/// @param key The pool to swap in
/// @param params The parameters for swapping
/// @param hookData The data to pass through to the swap hooks
/// @return swapDelta The balance delta of the address swapping
/// @dev Swapping on low liquidity pools may cause unexpected swap amounts when liquidity available is less than amountSpecified.
/// Additionally note that if interacting with hooks that have the BEFORE_SWAP_RETURNS_DELTA_FLAG or AFTER_SWAP_RETURNS_DELTA_FLAG
/// the hook may alter the swap input/output. Integrators should perform checks on the returned swapDelta.
function swap(PoolKey memory key, SwapParams memory params, bytes calldata hookData)
external
returns (BalanceDelta swapDelta);
/// @notice Donate the given currency amounts to the in-range liquidity providers of a pool
/// @dev Calls to donate can be frontrun adding just-in-time liquidity, with the aim of receiving a portion donated funds.
/// Donors should keep this in mind when designing donation mechanisms.
/// @dev This function donates to in-range LPs at slot0.tick. In certain edge-cases of the swap algorithm, the `sqrtPrice` of
/// a pool can be at the lower boundary of tick `n`, but the `slot0.tick` of the pool is already `n - 1`. In this case a call to
/// `donate` would donate to tick `n - 1` (slot0.tick) not tick `n` (getTickAtSqrtPrice(slot0.sqrtPriceX96)).
/// Read the comments in `Pool.swap()` for more information about this.
/// @param key The key of the pool to donate to
/// @param amount0 The amount of currency0 to donate
/// @param amount1 The amount of currency1 to donate
/// @param hookData The data to pass through to the donate hooks
/// @return BalanceDelta The delta of the caller after the donate
function donate(PoolKey memory key, uint256 amount0, uint256 amount1, bytes calldata hookData)
external
returns (BalanceDelta);
/// @notice Writes the current ERC20 balance of the specified currency to transient storage
/// This is used to checkpoint balances for the manager and derive deltas for the caller.
/// @dev This MUST be called before any ERC20 tokens are sent into the contract, but can be skipped
/// for native tokens because the amount to settle is determined by the sent value.
/// However, if an ERC20 token has been synced and not settled, and the caller instead wants to settle
/// native funds, this function can be called with the native currency to then be able to settle the native currency
function sync(Currency currency) external;
/// @notice Called by the user to net out some value owed to the user
/// @dev Will revert if the requested amount is not available, consider using `mint` instead
/// @dev Can also be used as a mechanism for free flash loans
/// @param currency The currency to withdraw from the pool manager
/// @param to The address to withdraw to
/// @param amount The amount of currency to withdraw
function take(Currency currency, address to, uint256 amount) external;
/// @notice Called by the user to pay what is owed
/// @return paid The amount of currency settled
function settle() external payable returns (uint256 paid);
/// @notice Called by the user to pay on behalf of another address
/// @param recipient The address to credit for the payment
/// @return paid The amount of currency settled
function settleFor(address recipient) external payable returns (uint256 paid);
/// @notice WARNING - Any currency that is cleared, will be non-retrievable, and locked in the contract permanently.
/// A call to clear will zero out a positive balance WITHOUT a corresponding transfer.
/// @dev This could be used to clear a balance that is considered dust.
/// Additionally, the amount must be the exact positive balance. This is to enforce that the caller is aware of the amount being cleared.
function clear(Currency currency, uint256 amount) external;
/// @notice Called by the user to move value into ERC6909 balance
/// @param to The address to mint the tokens to
/// @param id The currency address to mint to ERC6909s, as a uint256
/// @param amount The amount of currency to mint
/// @dev The id is converted to a uint160 to correspond to a currency address
/// If the upper 12 bytes are not 0, they will be 0-ed out
function mint(address to, uint256 id, uint256 amount) external;
/// @notice Called by the user to move value from ERC6909 balance
/// @param from The address to burn the tokens from
/// @param id The currency address to burn from ERC6909s, as a uint256
/// @param amount The amount of currency to burn
/// @dev The id is converted to a uint160 to correspond to a currency address
/// If the upper 12 bytes are not 0, they will be 0-ed out
function burn(address from, uint256 id, uint256 amount) external;
/// @notice Updates the pools lp fees for the a pool that has enabled dynamic lp fees.
/// @dev A swap fee totaling MAX_SWAP_FEE (100%) makes exact output swaps impossible since the input is entirely consumed by the fee
/// @param key The key of the pool to update dynamic LP fees for
/// @param newDynamicLPFee The new dynamic pool LP fee
function updateDynamicLPFee(PoolKey memory key, uint24 newDynamicLPFee) external;
}
contracts/lib/v4-periphery/lib/permit2/src/interfaces/IEIP712.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
interface IEIP712 {
function DOMAIN_SEPARATOR() external view returns (bytes32);
}
contracts/src/v2/interfaces/ILaunchpadV2.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
/**
* @notice Shared pons v2 interfaces: fee escrow, fee policy, and the launch
* factory/curve records. Uniswap V4 core and periphery types are imported
* directly from the vendored packages by the contracts that need them,
* rather than re-declared here.
*/
/**
* @notice Claimable balance ledger shared by every v2 bonding curve and the
* meme hook. Native ETH crediting is permissionless (callers attach the ETH
* they are crediting). Token crediting requires the caller to hold the
* tokens themselves, pulled via `transferFrom`, so it is equally safe to
* leave open. Token support exists for launches whose deployer-chosen
* pairToken is a non-native ERC-20: those curves trade and credit in that
* asset from the first trade through to graduation.
*/
interface IPonsV2FeeEscrow {
function credit(address recipient) external payable;
function creditToken(address recipient, address token, uint256 amount) external;
function claim() external returns (uint256 amount);
function claim(uint256 amount) external returns (uint256);
function claimToken(address token) external returns (uint256 amount);
function claimToken(address token, uint256 amount) external returns (uint256);
function balanceOf(address recipient) external view returns (uint256);
function balanceOfToken(address recipient, address token) external view returns (uint256);
}
/**
* @notice Fee terms frozen for one launch when its curve is created and its
* graduated pool is registered. Global hook configuration only governs
* launches created after a later policy update.
*/
struct FeePolicySnapshot {
address protocolFeeRecipient;
uint16 protocolFeeShareBps;
uint16 buybackBurnBps;
uint16 hookFeeBps;
uint16 maxInternalPriceImpactBps;
}
/**
* @notice Protocol-owned fee policy read by every bonding curve and by the
* meme hook. The current policy is snapshotted at launch, while the live
* sweep operator remains rotatable for operational liveness.
*/
interface IPonsV2FeePolicy {
function protocolFeeShareBps() external view returns (uint256);
function buybackBurnBps() external view returns (uint256);
function protocolFeeRecipient() external view returns (address);
function feeEscrow() external view returns (IPonsV2FeeEscrow);
// Ceiling on how much a single internal buyback conversion is allowed
// to move the pool's own price, read by the meme hook's real internal
// swaps and by the bonding curve's pre-graduation buyback pricing so
// both phases apply the same conservative bound.
function maxInternalPriceImpactBps() external view returns (uint256);
function feeSweepOperator() external view returns (address);
function currentFeePolicy() external view returns (FeePolicySnapshot memory);
}
/**
* @notice Anti-snipe tax terms each bonding curve snapshots from the factory
* when it initializes, inside its own launch transaction. Implemented by
* PonsV2LaunchFactory as owner-mutable settings that govern launches from
* the moment they change; a curve already trading keeps the terms it
* launched under, so a factory retune can never reprice an open launch
* window. `snipeTaxStartBps` is the tax charged in the launch second, in
* basis points of a buy's quote leg, decaying exponentially to zero across
* `snipeTaxSeconds`. A zero starting tax disables the mechanism.
*/
interface IPonsV2SnipeTax {
function snipeTaxStartBps() external view returns (uint256);
function snipeTaxSeconds() external view returns (uint256);
}
/**
* @notice Minimal ERC-721 receiver signature used by PonsV2LaunchLocker to
* accept the graduated Uniswap V4 position NFT.
*/
interface IERC721ReceiverLike {
function onERC721Received(address operator, address from, uint256 tokenId, bytes calldata data)
external
returns (bytes4);
}
/**
* @notice Graduation proceeds in two phases so the slippage-sensitive step
* is never bundled with the automatic, threshold-crossing trigger:
* - NotGraduated: still trading on the bonding curve.
* - Swept: the curve has been drained (fees swept, trading halted, ETH and
* the remaining token supply pulled into the factory); still needs a V4
* pool.
* - PoolCreated: the V4 pool exists, its full-range position is locked, and
* the meme hook is registered for it.
* - Rescued: the swept reserves were released manually because the launch's
* quote asset stopped being able to deliver an exact transfer, which no
* retry of the seed step could ever satisfy. Terminal, like PoolCreated.
*/
enum GraduationPhase {
NotGraduated,
Swept,
PoolCreated,
Rescued
}
/**
* @notice Record kept by PonsV2LaunchFactory for every launch, readable by
* the locker and by off-chain indexers.
*/
interface IPonsV2LaunchFactory {
struct LaunchedToken {
address token;
address curve;
address deployer;
address creatorFeeRecipient;
address pairToken;
uint256 graduationThreshold;
// Snapshotted from the launch config at launch time, so a later
// config edit can never change the pool a token graduates into.
uint24 poolFee;
int24 tickSpacing;
// Creator-chosen at launch, capped by the protocol's maxCreatorTaxBps
// at the time of launch; an additional trade fee charged the same
// way the base fee is, paid entirely to the creator.
uint16 creatorTaxBps;
bool buybackEnabled;
GraduationPhase phase;
uint256 sweptQuote;
uint256 sweptTokens;
uint256 sweptAt;
bool exists;
}
function getLaunchedToken(address token) external view returns (LaunchedToken memory);
}
/**
* @notice Narrow surface the factory needs from a bonding curve to trigger
* graduation once the ETH threshold has been crossed.
*/
interface IPonsV2BondingCurve {
function token() external view returns (address);
function pairToken() external view returns (address);
function graduationThreshold() external view returns (uint256);
function graduated() external view returns (bool);
function quoteReserve() external view returns (uint256);
function realQuoteReserve() external view returns (uint256);
function tokenReserve() external view returns (uint256);
function readyToGraduate() external view returns (bool);
function sweepFees(uint256 minBuybackTokensOut) external;
function graduate(address recipient) external returns (uint256 ethOut, uint256 tokenOut);
}
contracts/lib/v4-periphery/src/interfaces/IImmutableState.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
/// @title IImmutableState
/// @notice Interface for the ImmutableState contract
interface IImmutableState {
/// @notice The Uniswap v4 PoolManager contract
function poolManager() external view returns (IPoolManager);
}
contracts/lib/openzeppelin-contracts/contracts/interfaces/IERC20Metadata.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC20Metadata.sol)
pragma solidity >=0.6.2;
import {IERC20Metadata} from "../token/ERC20/extensions/IERC20Metadata.sol";
contracts/lib/v4-core/src/libraries/SafeCast.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {CustomRevert} from "./CustomRevert.sol";
/// @title Safe casting methods
/// @notice Contains methods for safely casting between types
library SafeCast {
using CustomRevert for bytes4;
error SafeCastOverflow();
/// @notice Cast a uint256 to a uint160, revert on overflow
/// @param x The uint256 to be downcasted
/// @return y The downcasted integer, now type uint160
function toUint160(uint256 x) internal pure returns (uint160 y) {
y = uint160(x);
if (y != x) SafeCastOverflow.selector.revertWith();
}
/// @notice Cast a uint256 to a uint128, revert on overflow
/// @param x The uint256 to be downcasted
/// @return y The downcasted integer, now type uint128
function toUint128(uint256 x) internal pure returns (uint128 y) {
y = uint128(x);
if (x != y) SafeCastOverflow.selector.revertWith();
}
/// @notice Cast a int128 to a uint128, revert on overflow or underflow
/// @param x The int128 to be casted
/// @return y The casted integer, now type uint128
function toUint128(int128 x) internal pure returns (uint128 y) {
if (x < 0) SafeCastOverflow.selector.revertWith();
y = uint128(x);
}
/// @notice Cast a int256 to a int128, revert on overflow or underflow
/// @param x The int256 to be downcasted
/// @return y The downcasted integer, now type int128
function toInt128(int256 x) internal pure returns (int128 y) {
y = int128(x);
if (y != x) SafeCastOverflow.selector.revertWith();
}
/// @notice Cast a uint256 to a int256, revert on overflow
/// @param x The uint256 to be casted
/// @return y The casted integer, now type int256
function toInt256(uint256 x) internal pure returns (int256 y) {
y = int256(x);
if (y < 0) SafeCastOverflow.selector.revertWith();
}
/// @notice Cast a uint256 to a int128, revert on overflow
/// @param x The uint256 to be downcasted
/// @return The downcasted integer, now type int128
function toInt128(uint256 x) internal pure returns (int128) {
if (x >= 1 << 127) SafeCastOverflow.selector.revertWith();
return int128(int256(x));
}
}
contracts/src/v2/interfaces/ILaunchpadV2Graduation.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
/**
* @notice Narrow callback a bonding curve uses to ask its factory to graduate
* a token the instant a buy crosses the ETH threshold. Kept separate from
* ILaunchpadV2.sol so the curve's compile unit stays free of the factory's
* full launch-record surface.
*/
interface IPonsV2LaunchFactoryGraduation {
function graduate(address token) external;
}
contracts/lib/v4-core/src/libraries/StateLibrary.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {PoolId} from "../types/PoolId.sol";
import {IPoolManager} from "../interfaces/IPoolManager.sol";
import {Position} from "./Position.sol";
/// @notice A helper library to provide state getters that use extsload
library StateLibrary {
/// @notice index of pools mapping in the PoolManager
bytes32 public constant POOLS_SLOT = bytes32(uint256(6));
/// @notice index of feeGrowthGlobal0X128 in Pool.State
uint256 public constant FEE_GROWTH_GLOBAL0_OFFSET = 1;
// feeGrowthGlobal1X128 offset in Pool.State = 2
/// @notice index of liquidity in Pool.State
uint256 public constant LIQUIDITY_OFFSET = 3;
/// @notice index of TicksInfo mapping in Pool.State: mapping(int24 => TickInfo) ticks;
uint256 public constant TICKS_OFFSET = 4;
/// @notice index of tickBitmap mapping in Pool.State
uint256 public constant TICK_BITMAP_OFFSET = 5;
/// @notice index of Position.State mapping in Pool.State: mapping(bytes32 => Position.State) positions;
uint256 public constant POSITIONS_OFFSET = 6;
/**
* @notice Get Slot0 of the pool: sqrtPriceX96, tick, protocolFee, lpFee
* @dev Corresponds to pools[poolId].slot0
* @param manager The pool manager contract.
* @param poolId The ID of the pool.
* @return sqrtPriceX96 The square root of the price of the pool, in Q96 precision.
* @return tick The current tick of the pool.
* @return protocolFee The protocol fee of the pool.
* @return lpFee The swap fee of the pool.
*/
function getSlot0(IPoolManager manager, PoolId poolId)
internal
view
returns (uint160 sqrtPriceX96, int24 tick, uint24 protocolFee, uint24 lpFee)
{
// slot key of Pool.State value: `pools[poolId]`
bytes32 stateSlot = _getPoolStateSlot(poolId);
bytes32 data = manager.extsload(stateSlot);
// 24 bits |24bits|24bits |24 bits|160 bits
// 0x000000 |000bb8|000000 |ffff75 |0000000000000000fe3aa841ba359daa0ea9eff7
// ---------- | fee |protocolfee | tick | sqrtPriceX96
assembly ("memory-safe") {
// bottom 160 bits of data
sqrtPriceX96 := and(data, 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF)
// next 24 bits of data
tick := signextend(2, shr(160, data))
// next 24 bits of data
protocolFee := and(shr(184, data), 0xFFFFFF)
// last 24 bits of data
lpFee := and(shr(208, data), 0xFFFFFF)
}
}
/**
* @notice Retrieves the tick information of a pool at a specific tick.
* @dev Corresponds to pools[poolId].ticks[tick]
* @param manager The pool manager contract.
* @param poolId The ID of the pool.
* @param tick The tick to retrieve information for.
* @return liquidityGross The total position liquidity that references this tick
* @return liquidityNet The amount of net liquidity added (subtracted) when tick is crossed from left to right (right to left)
* @return feeGrowthOutside0X128 fee growth per unit of liquidity on the _other_ side of this tick (relative to the current tick)
* @return feeGrowthOutside1X128 fee growth per unit of liquidity on the _other_ side of this tick (relative to the current tick)
*/
function getTickInfo(IPoolManager manager, PoolId poolId, int24 tick)
internal
view
returns (
uint128 liquidityGross,
int128 liquidityNet,
uint256 feeGrowthOutside0X128,
uint256 feeGrowthOutside1X128
)
{
bytes32 slot = _getTickInfoSlot(poolId, tick);
// read all 3 words of the TickInfo struct
bytes32[] memory data = manager.extsload(slot, 3);
assembly ("memory-safe") {
let firstWord := mload(add(data, 32))
liquidityNet := sar(128, firstWord)
liquidityGross := and(firstWord, 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF)
feeGrowthOutside0X128 := mload(add(data, 64))
feeGrowthOutside1X128 := mload(add(data, 96))
}
}
/**
* @notice Retrieves the liquidity information of a pool at a specific tick.
* @dev Corresponds to pools[poolId].ticks[tick].liquidityGross and pools[poolId].ticks[tick].liquidityNet. A more gas efficient version of getTickInfo
* @param manager The pool manager contract.
* @param poolId The ID of the pool.
* @param tick The tick to retrieve liquidity for.
* @return liquidityGross The total position liquidity that references this tick
* @return liquidityNet The amount of net liquidity added (subtracted) when tick is crossed from left to right (right to left)
*/
function getTickLiquidity(IPoolManager manager, PoolId poolId, int24 tick)
internal
view
returns (uint128 liquidityGross, int128 liquidityNet)
{
bytes32 slot = _getTickInfoSlot(poolId, tick);
bytes32 value = manager.extsload(slot);
assembly ("memory-safe") {
liquidityNet := sar(128, value)
liquidityGross := and(value, 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF)
}
}
/**
* @notice Retrieves the fee growth outside a tick range of a pool
* @dev Corresponds to pools[poolId].ticks[tick].feeGrowthOutside0X128 and pools[poolId].ticks[tick].feeGrowthOutside1X128. A more gas efficient version of getTickInfo
* @param manager The pool manager contract.
* @param poolId The ID of the pool.
* @param tick The tick to retrieve fee growth for.
* @return feeGrowthOutside0X128 fee growth per unit of liquidity on the _other_ side of this tick (relative to the current tick)
* @return feeGrowthOutside1X128 fee growth per unit of liquidity on the _other_ side of this tick (relative to the current tick)
*/
function getTickFeeGrowthOutside(IPoolManager manager, PoolId poolId, int24 tick)
internal
view
returns (uint256 feeGrowthOutside0X128, uint256 feeGrowthOutside1X128)
{
bytes32 slot = _getTickInfoSlot(poolId, tick);
// offset by 1 word, since the first word is liquidityGross + liquidityNet
bytes32[] memory data = manager.extsload(bytes32(uint256(slot) + 1), 2);
assembly ("memory-safe") {
feeGrowthOutside0X128 := mload(add(data, 32))
feeGrowthOutside1X128 := mload(add(data, 64))
}
}
/**
* @notice Retrieves the global fee growth of a pool.
* @dev Corresponds to pools[poolId].feeGrowthGlobal0X128 and pools[poolId].feeGrowthGlobal1X128
* @param manager The pool manager contract.
* @param poolId The ID of the pool.
* @return feeGrowthGlobal0 The global fee growth for token0.
* @return feeGrowthGlobal1 The global fee growth for token1.
* @dev Note that feeGrowthGlobal can be artificially inflated
* For pools with a single liquidity position, actors can donate to themselves to freely inflate feeGrowthGlobal
* atomically donating and collecting fees in the same unlockCallback may make the inflated value more extreme
*/
function getFeeGrowthGlobals(IPoolManager manager, PoolId poolId)
internal
view
returns (uint256 feeGrowthGlobal0, uint256 feeGrowthGlobal1)
{
// slot key of Pool.State value: `pools[poolId]`
bytes32 stateSlot = _getPoolStateSlot(poolId);
// Pool.State, `uint256 feeGrowthGlobal0X128`
bytes32 slot_feeGrowthGlobal0X128 = bytes32(uint256(stateSlot) + FEE_GROWTH_GLOBAL0_OFFSET);
// read the 2 words of feeGrowthGlobal
bytes32[] memory data = manager.extsload(slot_feeGrowthGlobal0X128, 2);
assembly ("memory-safe") {
feeGrowthGlobal0 := mload(add(data, 32))
feeGrowthGlobal1 := mload(add(data, 64))
}
}
/**
* @notice Retrieves total the liquidity of a pool.
* @dev Corresponds to pools[poolId].liquidity
* @param manager The pool manager contract.
* @param poolId The ID of the pool.
* @return liquidity The liquidity of the pool.
*/
function getLiquidity(IPoolManager manager, PoolId poolId) internal view returns (uint128 liquidity) {
// slot key of Pool.State value: `pools[poolId]`
bytes32 stateSlot = _getPoolStateSlot(poolId);
// Pool.State: `uint128 liquidity`
bytes32 slot = bytes32(uint256(stateSlot) + LIQUIDITY_OFFSET);
liquidity = uint128(uint256(manager.extsload(slot)));
}
/**
* @notice Retrieves the tick bitmap of a pool at a specific tick.
* @dev Corresponds to pools[poolId].tickBitmap[tick]
* @param manager The pool manager contract.
* @param poolId The ID of the pool.
* @param tick The tick to retrieve the bitmap for.
* @return tickBitmap The bitmap of the tick.
*/
function getTickBitmap(IPoolManager manager, PoolId poolId, int16 tick)
internal
view
returns (uint256 tickBitmap)
{
// slot key of Pool.State value: `pools[poolId]`
bytes32 stateSlot = _getPoolStateSlot(poolId);
// Pool.State: `mapping(int16 => uint256) tickBitmap;`
bytes32 tickBitmapMapping = bytes32(uint256(stateSlot) + TICK_BITMAP_OFFSET);
// slot id of the mapping key: `pools[poolId].tickBitmap[tick]
bytes32 slot = keccak256(abi.encodePacked(int256(tick), tickBitmapMapping));
tickBitmap = uint256(manager.extsload(slot));
}
/**
* @notice Retrieves the position information of a pool without needing to calculate the `positionId`.
* @dev Corresponds to pools[poolId].positions[positionId]
* @param poolId The ID of the pool.
* @param owner The owner of the liquidity position.
* @param tickLower The lower tick of the liquidity range.
* @param tickUpper The upper tick of the liquidity range.
* @param salt The bytes32 randomness to further distinguish position state.
* @return liquidity The liquidity of the position.
* @return feeGrowthInside0LastX128 The fee growth inside the position for token0.
* @return feeGrowthInside1LastX128 The fee growth inside the position for token1.
*/
function getPositionInfo(
IPoolManager manager,
PoolId poolId,
address owner,
int24 tickLower,
int24 tickUpper,
bytes32 salt
) internal view returns (uint128 liquidity, uint256 feeGrowthInside0LastX128, uint256 feeGrowthInside1LastX128) {
// positionKey = keccak256(abi.encodePacked(owner, tickLower, tickUpper, salt))
bytes32 positionKey = Position.calculatePositionKey(owner, tickLower, tickUpper, salt);
(liquidity, feeGrowthInside0LastX128, feeGrowthInside1LastX128) = getPositionInfo(manager, poolId, positionKey);
}
/**
* @notice Retrieves the position information of a pool at a specific position ID.
* @dev Corresponds to pools[poolId].positions[positionId]
* @param manager The pool manager contract.
* @param poolId The ID of the pool.
* @param positionId The ID of the position.
* @return liquidity The liquidity of the position.
* @return feeGrowthInside0LastX128 The fee growth inside the position for token0.
* @return feeGrowthInside1LastX128 The fee growth inside the position for token1.
*/
function getPositionInfo(IPoolManager manager, PoolId poolId, bytes32 positionId)
internal
view
returns (uint128 liquidity, uint256 feeGrowthInside0LastX128, uint256 feeGrowthInside1LastX128)
{
bytes32 slot = _getPositionInfoSlot(poolId, positionId);
// read all 3 words of the Position.State struct
bytes32[] memory data = manager.extsload(slot, 3);
assembly ("memory-safe") {
liquidity := mload(add(data, 32))
feeGrowthInside0LastX128 := mload(add(data, 64))
feeGrowthInside1LastX128 := mload(add(data, 96))
}
}
/**
* @notice Retrieves the liquidity of a position.
* @dev Corresponds to pools[poolId].positions[positionId].liquidity. More gas efficient for just retrieiving liquidity as compared to getPositionInfo
* @param manager The pool manager contract.
* @param poolId The ID of the pool.
* @param positionId The ID of the position.
* @return liquidity The liquidity of the position.
*/
function getPositionLiquidity(IPoolManager manager, PoolId poolId, bytes32 positionId)
internal
view
returns (uint128 liquidity)
{
bytes32 slot = _getPositionInfoSlot(poolId, positionId);
liquidity = uint128(uint256(manager.extsload(slot)));
}
/**
* @notice Calculate the fee growth inside a tick range of a pool
* @dev pools[poolId].feeGrowthInside0LastX128 in Position.State is cached and can become stale. This function will calculate the up to date feeGrowthInside
* @param manager The pool manager contract.
* @param poolId The ID of the pool.
* @param tickLower The lower tick of the range.
* @param tickUpper The upper tick of the range.
* @return feeGrowthInside0X128 The fee growth inside the tick range for token0.
* @return feeGrowthInside1X128 The fee growth inside the tick range for token1.
*/
function getFeeGrowthInside(IPoolManager manager, PoolId poolId, int24 tickLower, int24 tickUpper)
internal
view
returns (uint256 feeGrowthInside0X128, uint256 feeGrowthInside1X128)
{
(uint256 feeGrowthGlobal0X128, uint256 feeGrowthGlobal1X128) = getFeeGrowthGlobals(manager, poolId);
(uint256 lowerFeeGrowthOutside0X128, uint256 lowerFeeGrowthOutside1X128) =
getTickFeeGrowthOutside(manager, poolId, tickLower);
(uint256 upperFeeGrowthOutside0X128, uint256 upperFeeGrowthOutside1X128) =
getTickFeeGrowthOutside(manager, poolId, tickUpper);
(, int24 tickCurrent,,) = getSlot0(manager, poolId);
unchecked {
if (tickCurrent < tickLower) {
feeGrowthInside0X128 = lowerFeeGrowthOutside0X128 - upperFeeGrowthOutside0X128;
feeGrowthInside1X128 = lowerFeeGrowthOutside1X128 - upperFeeGrowthOutside1X128;
} else if (tickCurrent >= tickUpper) {
feeGrowthInside0X128 = upperFeeGrowthOutside0X128 - lowerFeeGrowthOutside0X128;
feeGrowthInside1X128 = upperFeeGrowthOutside1X128 - lowerFeeGrowthOutside1X128;
} else {
feeGrowthInside0X128 = feeGrowthGlobal0X128 - lowerFeeGrowthOutside0X128 - upperFeeGrowthOutside0X128;
feeGrowthInside1X128 = feeGrowthGlobal1X128 - lowerFeeGrowthOutside1X128 - upperFeeGrowthOutside1X128;
}
}
}
function _getPoolStateSlot(PoolId poolId) internal pure returns (bytes32) {
return keccak256(abi.encodePacked(PoolId.unwrap(poolId), POOLS_SLOT));
}
function _getTickInfoSlot(PoolId poolId, int24 tick) internal pure returns (bytes32) {
// slot key of Pool.State value: `pools[poolId]`
bytes32 stateSlot = _getPoolStateSlot(poolId);
// Pool.State: `mapping(int24 => TickInfo) ticks`
bytes32 ticksMappingSlot = bytes32(uint256(stateSlot) + TICKS_OFFSET);
// slot key of the tick key: `pools[poolId].ticks[tick]
return keccak256(abi.encodePacked(int256(tick), ticksMappingSlot));
}
function _getPositionInfoSlot(PoolId poolId, bytes32 positionId) internal pure returns (bytes32) {
// slot key of Pool.State value: `pools[poolId]`
bytes32 stateSlot = _getPoolStateSlot(poolId);
// Pool.State: `mapping(bytes32 => Position.State) positions;`
bytes32 positionMapping = bytes32(uint256(stateSlot) + POSITIONS_OFFSET);
// slot of the mapping key: `pools[poolId].positions[positionId]
return keccak256(abi.encodePacked(positionId, positionMapping));
}
}
contracts/lib/v4-periphery/src/libraries/LiquidityAmounts.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {FullMath} from "@uniswap/v4-core/src/libraries/FullMath.sol";
import {FixedPoint96} from "@uniswap/v4-core/src/libraries/FixedPoint96.sol";
import {SafeCast} from "@uniswap/v4-core/src/libraries/SafeCast.sol";
/// @notice Provides functions for computing liquidity amounts from token amounts and prices
library LiquidityAmounts {
using SafeCast for uint256;
/// @notice Computes the amount of liquidity received for a given amount of token0 and price range
/// @dev Calculates amount0 * (sqrt(upper) * sqrt(lower)) / (sqrt(upper) - sqrt(lower))
/// @param sqrtPriceAX96 A sqrt price representing the first tick boundary
/// @param sqrtPriceBX96 A sqrt price representing the second tick boundary
/// @param amount0 The amount0 being sent in
/// @return liquidity The amount of returned liquidity
function getLiquidityForAmount0(uint160 sqrtPriceAX96, uint160 sqrtPriceBX96, uint256 amount0)
internal
pure
returns (uint128 liquidity)
{
unchecked {
if (sqrtPriceAX96 > sqrtPriceBX96) (sqrtPriceAX96, sqrtPriceBX96) = (sqrtPriceBX96, sqrtPriceAX96);
uint256 intermediate = FullMath.mulDiv(sqrtPriceAX96, sqrtPriceBX96, FixedPoint96.Q96);
return FullMath.mulDiv(amount0, intermediate, sqrtPriceBX96 - sqrtPriceAX96).toUint128();
}
}
/// @notice Computes the amount of liquidity received for a given amount of token1 and price range
/// @dev Calculates amount1 / (sqrt(upper) - sqrt(lower)).
/// @param sqrtPriceAX96 A sqrt price representing the first tick boundary
/// @param sqrtPriceBX96 A sqrt price representing the second tick boundary
/// @param amount1 The amount1 being sent in
/// @return liquidity The amount of returned liquidity
function getLiquidityForAmount1(uint160 sqrtPriceAX96, uint160 sqrtPriceBX96, uint256 amount1)
internal
pure
returns (uint128 liquidity)
{
unchecked {
if (sqrtPriceAX96 > sqrtPriceBX96) (sqrtPriceAX96, sqrtPriceBX96) = (sqrtPriceBX96, sqrtPriceAX96);
return FullMath.mulDiv(amount1, FixedPoint96.Q96, sqrtPriceBX96 - sqrtPriceAX96).toUint128();
}
}
/// @notice Computes the maximum amount of liquidity received for a given amount of token0, token1, the current
/// pool prices and the prices at the tick boundaries
/// @param sqrtPriceX96 A sqrt price representing the current pool prices
/// @param sqrtPriceAX96 A sqrt price representing the first tick boundary
/// @param sqrtPriceBX96 A sqrt price representing the second tick boundary
/// @param amount0 The amount of token0 being sent in
/// @param amount1 The amount of token1 being sent in
/// @return liquidity The maximum amount of liquidity received
function getLiquidityForAmounts(
uint160 sqrtPriceX96,
uint160 sqrtPriceAX96,
uint160 sqrtPriceBX96,
uint256 amount0,
uint256 amount1
) internal pure returns (uint128 liquidity) {
if (sqrtPriceAX96 > sqrtPriceBX96) {
(sqrtPriceAX96, sqrtPriceBX96) = (sqrtPriceBX96, sqrtPriceAX96);
}
if (sqrtPriceX96 <= sqrtPriceAX96) {
liquidity = getLiquidityForAmount0(sqrtPriceAX96, sqrtPriceBX96, amount0);
} else if (sqrtPriceX96 < sqrtPriceBX96) {
uint128 liquidity0 = getLiquidityForAmount0(sqrtPriceX96, sqrtPriceBX96, amount0);
uint128 liquidity1 = getLiquidityForAmount1(sqrtPriceAX96, sqrtPriceX96, amount1);
liquidity = liquidity0 < liquidity1 ? liquidity0 : liquidity1;
} else {
liquidity = getLiquidityForAmount1(sqrtPriceAX96, sqrtPriceBX96, amount1);
}
}
}
contracts/lib/v4-core/src/libraries/Pool.sol
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
import {SafeCast} from "./SafeCast.sol";
import {TickBitmap} from "./TickBitmap.sol";
import {Position} from "./Position.sol";
import {UnsafeMath} from "./UnsafeMath.sol";
import {FixedPoint128} from "./FixedPoint128.sol";
import {TickMath} from "./TickMath.sol";
import {SqrtPriceMath} from "./SqrtPriceMath.sol";
import {SwapMath} from "./SwapMath.sol";
import {BalanceDelta, toBalanceDelta, BalanceDeltaLibrary} from "../types/BalanceDelta.sol";
import {Slot0} from "../types/Slot0.sol";
import {ProtocolFeeLibrary} from "./ProtocolFeeLibrary.sol";
import {LiquidityMath} from "./LiquidityMath.sol";
import {LPFeeLibrary} from "./LPFeeLibrary.sol";
import {CustomRevert} from "./CustomRevert.sol";
/// @notice a library with all actions that can be performed on a pool
library Pool {
using SafeCast for *;
using TickBitmap for mapping(int16 => uint256);
using Position for mapping(bytes32 => Position.State);
using Position for Position.State;
using Pool for State;
using ProtocolFeeLibrary for *;
using LPFeeLibrary for uint24;
using CustomRevert for bytes4;
/// @notice Thrown when tickLower is not below tickUpper
/// @param tickLower The invalid tickLower
/// @param tickUpper The invalid tickUpper
error TicksMisordered(int24 tickLower, int24 tickUpper);
/// @notice Thrown when tickLower is less than min tick
/// @param tickLower The invalid tickLower
error TickLowerOutOfBounds(int24 tickLower);
/// @notice Thrown when tickUpper exceeds max tick
/// @param tickUpper The invalid tickUpper
error TickUpperOutOfBounds(int24 tickUpper);
/// @notice For the tick spacing, the tick has too much liquidity
error TickLiquidityOverflow(int24 tick);
/// @notice Thrown when trying to initialize an already initialized pool
error PoolAlreadyInitialized();
/// @notice Thrown when trying to interact with a non-initialized pool
error PoolNotInitialized();
/// @notice Thrown when sqrtPriceLimitX96 on a swap has already exceeded its limit
/// @param sqrtPriceCurrentX96 The invalid, already surpassed sqrtPriceLimitX96
/// @param sqrtPriceLimitX96 The surpassed price limit
error PriceLimitAlreadyExceeded(uint160 sqrtPriceCurrentX96, uint160 sqrtPriceLimitX96);
/// @notice Thrown when sqrtPriceLimitX96 lies outside of valid tick/price range
/// @param sqrtPriceLimitX96 The invalid, out-of-bounds sqrtPriceLimitX96
error PriceLimitOutOfBounds(uint160 sqrtPriceLimitX96);
/// @notice Thrown by donate if there is currently 0 liquidity, since the fees will not go to any liquidity providers
error NoLiquidityToReceiveFees();
/// @notice Thrown when trying to swap with max lp fee and specifying an output amount
error InvalidFeeForExactOut();
// info stored for each initialized individual tick
struct TickInfo {
// the total position liquidity that references this tick
uint128 liquidityGross;
// amount of net liquidity added (subtracted) when tick is crossed from left to right (right to left),
int128 liquidityNet;
// fee growth per unit of liquidity on the _other_ side of this tick (relative to the current tick)
// only has relative meaning, not absolute — the value depends on when the tick is initialized
uint256 feeGrowthOutside0X128;
uint256 feeGrowthOutside1X128;
}
/// @notice The state of a pool
/// @dev Note that feeGrowthGlobal can be artificially inflated
/// For pools with a single liquidity position, actors can donate to themselves to freely inflate feeGrowthGlobal
/// atomically donating and collecting fees in the same unlockCallback may make the inflated value more extreme
struct State {
Slot0 slot0;
uint256 feeGrowthGlobal0X128;
uint256 feeGrowthGlobal1X128;
uint128 liquidity;
mapping(int24 tick => TickInfo) ticks;
mapping(int16 wordPos => uint256) tickBitmap;
mapping(bytes32 positionKey => Position.State) positions;
}
/// @dev Common checks for valid tick inputs.
function checkTicks(int24 tickLower, int24 tickUpper) private pure {
if (tickLower >= tickUpper) TicksMisordered.selector.revertWith(tickLower, tickUpper);
if (tickLower < TickMath.MIN_TICK) TickLowerOutOfBounds.selector.revertWith(tickLower);
if (tickUpper > TickMath.MAX_TICK) TickUpperOutOfBounds.selector.revertWith(tickUpper);
}
function initialize(State storage self, uint160 sqrtPriceX96, uint24 lpFee) internal returns (int24 tick) {
if (self.slot0.sqrtPriceX96() != 0) PoolAlreadyInitialized.selector.revertWith();
tick = TickMath.getTickAtSqrtPrice(sqrtPriceX96);
// the initial protocolFee is 0 so doesn't need to be set
self.slot0 = Slot0.wrap(bytes32(0)).setSqrtPriceX96(sqrtPriceX96).setTick(tick).setLpFee(lpFee);
}
function setProtocolFee(State storage self, uint24 protocolFee) internal {
self.checkPoolInitialized();
self.slot0 = self.slot0.setProtocolFee(protocolFee);
}
/// @notice Only dynamic fee pools may update the lp fee.
function setLPFee(State storage self, uint24 lpFee) internal {
self.checkPoolInitialized();
self.slot0 = self.slot0.setLpFee(lpFee);
}
struct ModifyLiquidityParams {
// the address that owns the position
address owner;
// the lower and upper tick of the position
int24 tickLower;
int24 tickUpper;
// any change in liquidity
int128 liquidityDelta;
// the spacing between ticks
int24 tickSpacing;
// used to distinguish positions of the same owner, at the same tick range
bytes32 salt;
}
struct ModifyLiquidityState {
bool flippedLower;
uint128 liquidityGrossAfterLower;
bool flippedUpper;
uint128 liquidityGrossAfterUpper;
}
/// @notice Effect changes to a position in a pool
/// @dev PoolManager checks that the pool is initialized before calling
/// @param params the position details and the change to the position's liquidity to effect
/// @return delta the deltas of the token balances of the pool, from the liquidity change
/// @return feeDelta the fees generated by the liquidity range
function modifyLiquidity(State storage self, ModifyLiquidityParams memory params)
internal
returns (BalanceDelta delta, BalanceDelta feeDelta)
{
int128 liquidityDelta = params.liquidityDelta;
int24 tickLower = params.tickLower;
int24 tickUpper = params.tickUpper;
checkTicks(tickLower, tickUpper);
{
ModifyLiquidityState memory state;
// if we need to update the ticks, do it
if (liquidityDelta != 0) {
(state.flippedLower, state.liquidityGrossAfterLower) =
updateTick(self, tickLower, liquidityDelta, false);
(state.flippedUpper, state.liquidityGrossAfterUpper) = updateTick(self, tickUpper, liquidityDelta, true);
// `>` and `>=` are logically equivalent here but `>=` is cheaper
if (liquidityDelta >= 0) {
uint128 maxLiquidityPerTick = tickSpacingToMaxLiquidityPerTick(params.tickSpacing);
if (state.liquidityGrossAfterLower > maxLiquidityPerTick) {
TickLiquidityOverflow.selector.revertWith(tickLower);
}
if (state.liquidityGrossAfterUpper > maxLiquidityPerTick) {
TickLiquidityOverflow.selector.revertWith(tickUpper);
}
}
if (state.flippedLower) {
self.tickBitmap.flipTick(tickLower, params.tickSpacing);
}
if (state.flippedUpper) {
self.tickBitmap.flipTick(tickUpper, params.tickSpacing);
}
}
{
(uint256 feeGrowthInside0X128, uint256 feeGrowthInside1X128) =
getFeeGrowthInside(self, tickLower, tickUpper);
Position.State storage position = self.positions.get(params.owner, tickLower, tickUpper, params.salt);
(uint256 feesOwed0, uint256 feesOwed1) =
position.update(liquidityDelta, feeGrowthInside0X128, feeGrowthInside1X128);
// Fees earned from LPing are calculated, and returned
feeDelta = toBalanceDelta(feesOwed0.toInt128(), feesOwed1.toInt128());
}
// clear any tick data that is no longer needed
if (liquidityDelta < 0) {
if (state.flippedLower) {
clearTick(self, tickLower);
}
if (state.flippedUpper) {
clearTick(self, tickUpper);
}
}
}
if (liquidityDelta != 0) {
Slot0 _slot0 = self.slot0;
(int24 tick, uint160 sqrtPriceX96) = (_slot0.tick(), _slot0.sqrtPriceX96());
if (tick < tickLower) {
// current tick is below the passed range; liquidity can only become in range by crossing from left to
// right, when we'll need _more_ currency0 (it's becoming more valuable) so user must provide it
delta = toBalanceDelta(
SqrtPriceMath.getAmount0Delta(
TickMath.getSqrtPriceAtTick(tickLower), TickMath.getSqrtPriceAtTick(tickUpper), liquidityDelta
).toInt128(),
0
);
} else if (tick < tickUpper) {
delta = toBalanceDelta(
SqrtPriceMath.getAmount0Delta(sqrtPriceX96, TickMath.getSqrtPriceAtTick(tickUpper), liquidityDelta)
.toInt128(),
SqrtPriceMath.getAmount1Delta(TickMath.getSqrtPriceAtTick(tickLower), sqrtPriceX96, liquidityDelta)
.toInt128()
);
self.liquidity = LiquidityMath.addDelta(self.liquidity, liquidityDelta);
} else {
// current tick is above the passed range; liquidity can only become in range by crossing from right to
// left, when we'll need _more_ currency1 (it's becoming more valuable) so user must provide it
delta = toBalanceDelta(
0,
SqrtPriceMath.getAmount1Delta(
TickMath.getSqrtPriceAtTick(tickLower), TickMath.getSqrtPriceAtTick(tickUpper), liquidityDelta
).toInt128()
);
}
}
}
// Tracks the state of a pool throughout a swap, and returns these values at the end of the swap
struct SwapResult {
// the current sqrt(price)
uint160 sqrtPriceX96;
// the tick associated with the current price
int24 tick;
// the current liquidity in range
uint128 liquidity;
}
struct StepComputations {
// the price at the beginning of the step
uint160 sqrtPriceStartX96;
// the next tick to swap to from the current tick in the swap direction
int24 tickNext;
// whether tickNext is initialized or not
bool initialized;
// sqrt(price) for the next tick (1/0)
uint160 sqrtPriceNextX96;
// how much is being swapped in in this step
uint256 amountIn;
// how much is being swapped out
uint256 amountOut;
// how much fee is being paid in
uint256 feeAmount;
// the global fee growth of the input token. updated in storage at the end of swap
uint256 feeGrowthGlobalX128;
}
struct SwapParams {
int256 amountSpecified;
int24 tickSpacing;
bool zeroForOne;
uint160 sqrtPriceLimitX96;
uint24 lpFeeOverride;
}
/// @notice Executes a swap against the state, and returns the amount deltas of the pool
/// @dev PoolManager checks that the pool is initialized before calling
function swap(State storage self, SwapParams memory params)
internal
returns (BalanceDelta swapDelta, uint256 amountToProtocol, uint24 swapFee, SwapResult memory result)
{
Slot0 slot0Start = self.slot0;
bool zeroForOne = params.zeroForOne;
uint256 protocolFee =
zeroForOne ? slot0Start.protocolFee().getZeroForOneFee() : slot0Start.protocolFee().getOneForZeroFee();
// the amount remaining to be swapped in/out of the input/output asset. initially set to the amountSpecified
int256 amountSpecifiedRemaining = params.amountSpecified;
// the amount swapped out/in of the output/input asset. initially set to 0
int256 amountCalculated = 0;
// initialize to the current sqrt(price)
result.sqrtPriceX96 = slot0Start.sqrtPriceX96();
// initialize to the current tick
result.tick = slot0Start.tick();
// initialize to the current liquidity
result.liquidity = self.liquidity;
// if the beforeSwap hook returned a valid fee override, use that as the LP fee, otherwise load from storage
// lpFee, swapFee, and protocolFee are all in pips
{
uint24 lpFee = params.lpFeeOverride.isOverride()
? params.lpFeeOverride.removeOverrideFlagAndValidate()
: slot0Start.lpFee();
swapFee = protocolFee == 0 ? lpFee : uint16(protocolFee).calculateSwapFee(lpFee);
}
// a swap fee totaling MAX_SWAP_FEE (100%) makes exact output swaps impossible since the input is entirely consumed by the fee
if (swapFee >= SwapMath.MAX_SWAP_FEE) {
// if exactOutput
if (params.amountSpecified > 0) {
InvalidFeeForExactOut.selector.revertWith();
}
}
// swapFee is the pool's fee in pips (LP fee + protocol fee)
// when the amount swapped is 0, there is no protocolFee applied and the fee amount paid to the protocol is set to 0
if (params.amountSpecified == 0) return (BalanceDeltaLibrary.ZERO_DELTA, 0, swapFee, result);
if (zeroForOne) {
if (params.sqrtPriceLimitX96 >= slot0Start.sqrtPriceX96()) {
PriceLimitAlreadyExceeded.selector.revertWith(slot0Start.sqrtPriceX96(), params.sqrtPriceLimitX96);
}
// Swaps can never occur at MIN_TICK, only at MIN_TICK + 1, except at initialization of a pool
// Under certain circumstances outlined below, the tick will preemptively reach MIN_TICK without swapping there
if (params.sqrtPriceLimitX96 <= TickMath.MIN_SQRT_PRICE) {
PriceLimitOutOfBounds.selector.revertWith(params.sqrtPriceLimitX96);
}
} else {
if (params.sqrtPriceLimitX96 <= slot0Start.sqrtPriceX96()) {
PriceLimitAlreadyExceeded.selector.revertWith(slot0Start.sqrtPriceX96(), params.sqrtPriceLimitX96);
}
if (params.sqrtPriceLimitX96 >= TickMath.MAX_SQRT_PRICE) {
PriceLimitOutOfBounds.selector.revertWith(params.sqrtPriceLimitX96);
}
}
StepComputations memory step;
step.feeGrowthGlobalX128 = zeroForOne ? self.feeGrowthGlobal0X128 : self.feeGrowthGlobal1X128;
// continue swapping as long as we haven't used the entire input/output and haven't reached the price limit
while (!(amountSpecifiedRemaining == 0 || result.sqrtPriceX96 == params.sqrtPriceLimitX96)) {
step.sqrtPriceStartX96 = result.sqrtPriceX96;
(step.tickNext, step.initialized) =
self.tickBitmap.nextInitializedTickWithinOneWord(result.tick, params.tickSpacing, zeroForOne);
// ensure that we do not overshoot the min/max tick, as the tick bitmap is not aware of these bounds
if (step.tickNext <= TickMath.MIN_TICK) {
step.tickNext = TickMath.MIN_TICK;
}
if (step.tickNext >= TickMath.MAX_TICK) {
step.tickNext = TickMath.MAX_TICK;
}
// get the price for the next tick
step.sqrtPriceNextX96 = TickMath.getSqrtPriceAtTick(step.tickNext);
// compute values to swap to the target tick, price limit, or point where input/output amount is exhausted
(result.sqrtPriceX96, step.amountIn, step.amountOut, step.feeAmount) = SwapMath.computeSwapStep(
result.sqrtPriceX96,
SwapMath.getSqrtPriceTarget(zeroForOne, step.sqrtPriceNextX96, params.sqrtPriceLimitX96),
result.liquidity,
amountSpecifiedRemaining,
swapFee
);
// if exactOutput
if (params.amountSpecified > 0) {
unchecked {
amountSpecifiedRemaining -= step.amountOut.toInt256();
}
amountCalculated -= (step.amountIn + step.feeAmount).toInt256();
} else {
// safe because we test that amountSpecified > amountIn + feeAmount in SwapMath
unchecked {
amountSpecifiedRemaining += (step.amountIn + step.feeAmount).toInt256();
}
amountCalculated += step.amountOut.toInt256();
}
// if the protocol fee is on, calculate how much is owed, decrement feeAmount, and increment protocolFee
if (protocolFee > 0) {
unchecked {
// step.amountIn does not include the swap fee, as it's already been taken from it,
// so add it back to get the total amountIn and use that to calculate the amount of fees owed to the protocol
// cannot overflow due to limits on the size of protocolFee and params.amountSpecified
// this rounds down to favor LPs over the protocol
uint256 delta = (swapFee == protocolFee)
? step.feeAmount // lp fee is 0, so the entire fee is owed to the protocol instead
: (step.amountIn + step.feeAmount) * protocolFee / ProtocolFeeLibrary.PIPS_DENOMINATOR;
// subtract it from the total fee and add it to the protocol fee
step.feeAmount -= delta;
amountToProtocol += delta;
}
}
// update global fee tracker
if (result.liquidity > 0) {
unchecked {
// FullMath.mulDiv isn't needed as the numerator can't overflow uint256 since tokens have a max supply of type(uint128).max
step.feeGrowthGlobalX128 +=
UnsafeMath.simpleMulDiv(step.feeAmount, FixedPoint128.Q128, result.liquidity);
}
}
// Shift tick if we reached the next price, and preemptively decrement for zeroForOne swaps to tickNext - 1.
// If the swap doesn't continue (if amountRemaining == 0 or sqrtPriceLimit is met), slot0.tick will be 1 less
// than getTickAtSqrtPrice(slot0.sqrtPrice). This doesn't affect swaps, but donation calls should verify both
// price and tick to reward the correct LPs.
if (result.sqrtPriceX96 == step.sqrtPriceNextX96) {
// if the tick is initialized, run the tick transition
if (step.initialized) {
(uint256 feeGrowthGlobal0X128, uint256 feeGrowthGlobal1X128) = zeroForOne
? (step.feeGrowthGlobalX128, self.feeGrowthGlobal1X128)
: (self.feeGrowthGlobal0X128, step.feeGrowthGlobalX128);
int128 liquidityNet =
Pool.crossTick(self, step.tickNext, feeGrowthGlobal0X128, feeGrowthGlobal1X128);
// if we're moving leftward, we interpret liquidityNet as the opposite sign
// safe because liquidityNet cannot be type(int128).min
unchecked {
if (zeroForOne) liquidityNet = -liquidityNet;
}
result.liquidity = LiquidityMath.addDelta(result.liquidity, liquidityNet);
}
unchecked {
result.tick = zeroForOne ? step.tickNext - 1 : step.tickNext;
}
} else if (result.sqrtPriceX96 != step.sqrtPriceStartX96) {
// recompute unless we're on a lower tick boundary (i.e. already transitioned ticks), and haven't moved
result.tick = TickMath.getTickAtSqrtPrice(result.sqrtPriceX96);
}
}
self.slot0 = slot0Start.setTick(result.tick).setSqrtPriceX96(result.sqrtPriceX96);
// update liquidity if it changed
if (self.liquidity != result.liquidity) self.liquidity = result.liquidity;
// update fee growth global
if (!zeroForOne) {
self.feeGrowthGlobal1X128 = step.feeGrowthGlobalX128;
} else {
self.feeGrowthGlobal0X128 = step.feeGrowthGlobalX128;
}
unchecked {
// "if currency1 is specified"
if (zeroForOne != (params.amountSpecified < 0)) {
swapDelta = toBalanceDelta(
amountCalculated.toInt128(), (params.amountSpecified - amountSpecifiedRemaining).toInt128()
);
} else {
swapDelta = toBalanceDelta(
(params.amountSpecified - amountSpecifiedRemaining).toInt128(), amountCalculated.toInt128()
);
}
}
}
/// @notice Donates the given amount of currency0 and currency1 to the pool
function donate(State storage state, uint256 amount0, uint256 amount1) internal returns (BalanceDelta delta) {
uint128 liquidity = state.liquidity;
if (liquidity == 0) NoLiquidityToReceiveFees.selector.revertWith();
unchecked {
// negation safe as amount0 and amount1 are always positive
delta = toBalanceDelta(-(amount0.toInt128()), -(amount1.toInt128()));
// FullMath.mulDiv is unnecessary because the numerator is bounded by type(int128).max * Q128, which is less than type(uint256).max
if (amount0 > 0) {
state.feeGrowthGlobal0X128 += UnsafeMath.simpleMulDiv(amount0, FixedPoint128.Q128, liquidity);
}
if (amount1 > 0) {
state.feeGrowthGlobal1X128 += UnsafeMath.simpleMulDiv(amount1, FixedPoint128.Q128, liquidity);
}
}
}
/// @notice Retrieves fee growth data
/// @param self The Pool state struct
/// @param tickLower The lower tick boundary of the position
/// @param tickUpper The upper tick boundary of the position
/// @return feeGrowthInside0X128 The all-time fee growth in token0, per unit of liquidity, inside the position's tick boundaries
/// @return feeGrowthInside1X128 The all-time fee growth in token1, per unit of liquidity, inside the position's tick boundaries
function getFeeGrowthInside(State storage self, int24 tickLower, int24 tickUpper)
internal
view
returns (uint256 feeGrowthInside0X128, uint256 feeGrowthInside1X128)
{
TickInfo storage lower = self.ticks[tickLower];
TickInfo storage upper = self.ticks[tickUpper];
int24 tickCurrent = self.slot0.tick();
unchecked {
if (tickCurrent < tickLower) {
feeGrowthInside0X128 = lower.feeGrowthOutside0X128 - upper.feeGrowthOutside0X128;
feeGrowthInside1X128 = lower.feeGrowthOutside1X128 - upper.feeGrowthOutside1X128;
} else if (tickCurrent >= tickUpper) {
feeGrowthInside0X128 = upper.feeGrowthOutside0X128 - lower.feeGrowthOutside0X128;
feeGrowthInside1X128 = upper.feeGrowthOutside1X128 - lower.feeGrowthOutside1X128;
} else {
feeGrowthInside0X128 =
self.feeGrowthGlobal0X128 - lower.feeGrowthOutside0X128 - upper.feeGrowthOutside0X128;
feeGrowthInside1X128 =
self.feeGrowthGlobal1X128 - lower.feeGrowthOutside1X128 - upper.feeGrowthOutside1X128;
}
}
}
/// @notice Updates a tick and returns true if the tick was flipped from initialized to uninitialized, or vice versa
/// @param self The mapping containing all tick information for initialized ticks
/// @param tick The tick that will be updated
/// @param liquidityDelta A new amount of liquidity to be added (subtracted) when tick is crossed from left to right (right to left)
/// @param upper true for updating a position's upper tick, or false for updating a position's lower tick
/// @return flipped Whether the tick was flipped from initialized to uninitialized, or vice versa
/// @return liquidityGrossAfter The total amount of liquidity for all positions that references the tick after the update
function updateTick(State storage self, int24 tick, int128 liquidityDelta, bool upper)
internal
returns (bool flipped, uint128 liquidityGrossAfter)
{
TickInfo storage info = self.ticks[tick];
uint128 liquidityGrossBefore = info.liquidityGross;
int128 liquidityNetBefore = info.liquidityNet;
liquidityGrossAfter = LiquidityMath.addDelta(liquidityGrossBefore, liquidityDelta);
flipped = (liquidityGrossAfter == 0) != (liquidityGrossBefore == 0);
if (liquidityGrossBefore == 0) {
// by convention, we assume that all growth before a tick was initialized happened _below_ the tick
if (tick <= self.slot0.tick()) {
info.feeGrowthOutside0X128 = self.feeGrowthGlobal0X128;
info.feeGrowthOutside1X128 = self.feeGrowthGlobal1X128;
}
}
// when the lower (upper) tick is crossed left to right, liquidity must be added (removed)
// when the lower (upper) tick is crossed right to left, liquidity must be removed (added)
int128 liquidityNet = upper ? liquidityNetBefore - liquidityDelta : liquidityNetBefore + liquidityDelta;
assembly ("memory-safe") {
// liquidityGrossAfter and liquidityNet are packed in the first slot of `info`
// So we can store them with a single sstore by packing them ourselves first
sstore(
info.slot,
// bitwise OR to pack liquidityGrossAfter and liquidityNet
or(
// Put liquidityGrossAfter in the lower bits, clearing out the upper bits
and(liquidityGrossAfter, 0xffffffffffffffffffffffffffffffff),
// Shift liquidityNet to put it in the upper bits (no need for signextend since we're shifting left)
shl(128, liquidityNet)
)
)
}
}
/// @notice Derives max liquidity per tick from given tick spacing
/// @dev Executed when adding liquidity
/// @param tickSpacing The amount of required tick separation, realized in multiples of `tickSpacing`
/// e.g., a tickSpacing of 3 requires ticks to be initialized every 3rd tick i.e., ..., -6, -3, 0, 3, 6, ...
/// @return result The max liquidity per tick
function tickSpacingToMaxLiquidityPerTick(int24 tickSpacing) internal pure returns (uint128 result) {
// Equivalent to:
// int24 minTick = (TickMath.MIN_TICK / tickSpacing);
// if (TickMath.MIN_TICK % tickSpacing != 0) minTick--;
// int24 maxTick = (TickMath.MAX_TICK / tickSpacing);
// uint24 numTicks = maxTick - minTick + 1;
// return type(uint128).max / numTicks;
int24 MAX_TICK = TickMath.MAX_TICK;
int24 MIN_TICK = TickMath.MIN_TICK;
// tick spacing will never be 0 since TickMath.MIN_TICK_SPACING is 1
assembly ("memory-safe") {
tickSpacing := signextend(2, tickSpacing)
let minTick := sub(sdiv(MIN_TICK, tickSpacing), slt(smod(MIN_TICK, tickSpacing), 0))
let maxTick := sdiv(MAX_TICK, tickSpacing)
let numTicks := add(sub(maxTick, minTick), 1)
result := div(sub(shl(128, 1), 1), numTicks)
}
}
/// @notice Reverts if the given pool has not been initialized
function checkPoolInitialized(State storage self) internal view {
if (self.slot0.sqrtPriceX96() == 0) PoolNotInitialized.selector.revertWith();
}
/// @notice Clears tick data
/// @param self The mapping containing all initialized tick information for initialized ticks
/// @param tick The tick that will be cleared
function clearTick(State storage self, int24 tick) internal {
delete self.ticks[tick];
}
/// @notice Transitions to next tick as needed by price movement
/// @param self The Pool state struct
/// @param tick The destination tick of the transition
/// @param feeGrowthGlobal0X128 The all-time global fee growth, per unit of liquidity, in token0
/// @param feeGrowthGlobal1X128 The all-time global fee growth, per unit of liquidity, in token1
/// @return liquidityNet The amount of liquidity added (subtracted) when tick is crossed from left to right (right to left)
function crossTick(State storage self, int24 tick, uint256 feeGrowthGlobal0X128, uint256 feeGrowthGlobal1X128)
internal
returns (int128 liquidityNet)
{
unchecked {
TickInfo storage info = self.ticks[tick];
info.feeGrowthOutside0X128 = feeGrowthGlobal0X128 - info.feeGrowthOutside0X128;
info.feeGrowthOutside1X128 = feeGrowthGlobal1X128 - info.feeGrowthOutside1X128;
liquidityNet = info.liquidityNet;
}
}
}
contracts/lib/v4-core/src/interfaces/IHooks.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {PoolKey} from "../types/PoolKey.sol";
import {BalanceDelta} from "../types/BalanceDelta.sol";
import {ModifyLiquidityParams, SwapParams} from "../types/PoolOperation.sol";
import {BeforeSwapDelta} from "../types/BeforeSwapDelta.sol";
/// @notice V4 decides whether to invoke specific hooks by inspecting the least significant bits
/// of the address that the hooks contract is deployed to.
/// For example, a hooks contract deployed to address: 0x0000000000000000000000000000000000002400
/// has the lowest bits '10 0100 0000 0000' which would cause the 'before initialize' and 'after add liquidity' hooks to be used.
/// See the Hooks library for the full spec.
/// @dev Should only be callable by the v4 PoolManager.
interface IHooks {
/// @notice The hook called before the state of a pool is initialized
/// @param sender The initial msg.sender for the initialize call
/// @param key The key for the pool being initialized
/// @param sqrtPriceX96 The sqrt(price) of the pool as a Q64.96
/// @return bytes4 The function selector for the hook
function beforeInitialize(address sender, PoolKey calldata key, uint160 sqrtPriceX96) external returns (bytes4);
/// @notice The hook called after the state of a pool is initialized
/// @param sender The initial msg.sender for the initialize call
/// @param key The key for the pool being initialized
/// @param sqrtPriceX96 The sqrt(price) of the pool as a Q64.96
/// @param tick The current tick after the state of a pool is initialized
/// @return bytes4 The function selector for the hook
function afterInitialize(address sender, PoolKey calldata key, uint160 sqrtPriceX96, int24 tick)
external
returns (bytes4);
/// @notice The hook called before liquidity is added
/// @param sender The initial msg.sender for the add liquidity call
/// @param key The key for the pool
/// @param params The parameters for adding liquidity
/// @param hookData Arbitrary data handed into the PoolManager by the liquidity provider to be passed on to the hook
/// @return bytes4 The function selector for the hook
function beforeAddLiquidity(
address sender,
PoolKey calldata key,
ModifyLiquidityParams calldata params,
bytes calldata hookData
) external returns (bytes4);
/// @notice The hook called after liquidity is added
/// @param sender The initial msg.sender for the add liquidity call
/// @param key The key for the pool
/// @param params The parameters for adding liquidity
/// @param delta The caller's balance delta after adding liquidity; the sum of principal delta, fees accrued, and hook delta
/// @param feesAccrued The fees accrued since the last time fees were collected from this position
/// @param hookData Arbitrary data handed into the PoolManager by the liquidity provider to be passed on to the hook
/// @return bytes4 The function selector for the hook
/// @return BalanceDelta The hook's delta in token0 and token1. Positive: the hook is owed/took currency, negative: the hook owes/sent currency
function afterAddLiquidity(
address sender,
PoolKey calldata key,
ModifyLiquidityParams calldata params,
BalanceDelta delta,
BalanceDelta feesAccrued,
bytes calldata hookData
) external returns (bytes4, BalanceDelta);
/// @notice The hook called before liquidity is removed
/// @param sender The initial msg.sender for the remove liquidity call
/// @param key The key for the pool
/// @param params The parameters for removing liquidity
/// @param hookData Arbitrary data handed into the PoolManager by the liquidity provider to be be passed on to the hook
/// @return bytes4 The function selector for the hook
function beforeRemoveLiquidity(
address sender,
PoolKey calldata key,
ModifyLiquidityParams calldata params,
bytes calldata hookData
) external returns (bytes4);
/// @notice The hook called after liquidity is removed
/// @param sender The initial msg.sender for the remove liquidity call
/// @param key The key for the pool
/// @param params The parameters for removing liquidity
/// @param delta The caller's balance delta after removing liquidity; the sum of principal delta, fees accrued, and hook delta
/// @param feesAccrued The fees accrued since the last time fees were collected from this position
/// @param hookData Arbitrary data handed into the PoolManager by the liquidity provider to be be passed on to the hook
/// @return bytes4 The function selector for the hook
/// @return BalanceDelta The hook's delta in token0 and token1. Positive: the hook is owed/took currency, negative: the hook owes/sent currency
function afterRemoveLiquidity(
address sender,
PoolKey calldata key,
ModifyLiquidityParams calldata params,
BalanceDelta delta,
BalanceDelta feesAccrued,
bytes calldata hookData
) external returns (bytes4, BalanceDelta);
/// @notice The hook called before a swap
/// @param sender The initial msg.sender for the swap call
/// @param key The key for the pool
/// @param params The parameters for the swap
/// @param hookData Arbitrary data handed into the PoolManager by the swapper to be be passed on to the hook
/// @return bytes4 The function selector for the hook
/// @return BeforeSwapDelta The hook's delta in specified and unspecified currencies. Positive: the hook is owed/took currency, negative: the hook owes/sent currency
/// @return uint24 Optionally override the lp fee, only used if three conditions are met: 1. the Pool has a dynamic fee, 2. the value's 2nd highest bit is set (23rd bit, 0x400000), and 3. the value is less than or equal to the maximum fee (1 million)
function beforeSwap(address sender, PoolKey calldata key, SwapParams calldata params, bytes calldata hookData)
external
returns (bytes4, BeforeSwapDelta, uint24);
/// @notice The hook called after a swap
/// @param sender The initial msg.sender for the swap call
/// @param key The key for the pool
/// @param params The parameters for the swap
/// @param delta The amount owed to the caller (positive) or owed to the pool (negative)
/// @param hookData Arbitrary data handed into the PoolManager by the swapper to be be passed on to the hook
/// @return bytes4 The function selector for the hook
/// @return int128 The hook's delta in unspecified currency. Positive: the hook is owed/took currency, negative: the hook owes/sent currency
function afterSwap(
address sender,
PoolKey calldata key,
SwapParams calldata params,
BalanceDelta delta,
bytes calldata hookData
) external returns (bytes4, int128);
/// @notice The hook called before donate
/// @param sender The initial msg.sender for the donate call
/// @param key The key for the pool
/// @param amount0 The amount of token0 being donated
/// @param amount1 The amount of token1 being donated
/// @param hookData Arbitrary data handed into the PoolManager by the donor to be be passed on to the hook
/// @return bytes4 The function selector for the hook
function beforeDonate(
address sender,
PoolKey calldata key,
uint256 amount0,
uint256 amount1,
bytes calldata hookData
) external returns (bytes4);
/// @notice The hook called after donate
/// @param sender The initial msg.sender for the donate call
/// @param key The key for the pool
/// @param amount0 The amount of token0 being donated
/// @param amount1 The amount of token1 being donated
/// @param hookData Arbitrary data handed into the PoolManager by the donor to be be passed on to the hook
/// @return bytes4 The function selector for the hook
function afterDonate(
address sender,
PoolKey calldata key,
uint256 amount0,
uint256 amount1,
bytes calldata hookData
) external returns (bytes4);
}
contracts/lib/v4-core/src/interfaces/external/IERC20Minimal.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title Minimal ERC20 interface for Uniswap
/// @notice Contains a subset of the full ERC20 interface that is used in Uniswap V3
interface IERC20Minimal {
/// @notice Returns an account's balance in the token
/// @param account The account for which to look up the number of tokens it has, i.e. its balance
/// @return The number of tokens held by the account
function balanceOf(address account) external view returns (uint256);
/// @notice Transfers the amount of token from the `msg.sender` to the recipient
/// @param recipient The account that will receive the amount transferred
/// @param amount The number of tokens to send from the sender to the recipient
/// @return Returns true for a successful transfer, false for an unsuccessful transfer
function transfer(address recipient, uint256 amount) external returns (bool);
/// @notice Returns the current allowance given to a spender by an owner
/// @param owner The account of the token owner
/// @param spender The account of the token spender
/// @return The current allowance granted by `owner` to `spender`
function allowance(address owner, address spender) external view returns (uint256);
/// @notice Sets the allowance of a spender from the `msg.sender` to the value `amount`
/// @param spender The account which will be allowed to spend a given amount of the owners tokens
/// @param amount The amount of tokens allowed to be used by `spender`
/// @return Returns true for a successful approval, false for unsuccessful
function approve(address spender, uint256 amount) external returns (bool);
/// @notice Transfers `amount` tokens from `sender` to `recipient` up to the allowance given to the `msg.sender`
/// @param sender The account from which the transfer will be initiated
/// @param recipient The recipient of the transfer
/// @param amount The amount of the transfer
/// @return Returns true for a successful transfer, false for unsuccessful
function transferFrom(address sender, address recipient, uint256 amount) external returns (bool);
/// @notice Event emitted when tokens are transferred from one address to another, either via `#transfer` or `#transferFrom`.
/// @param from The account from which the tokens were sent, i.e. the balance decreased
/// @param to The account to which the tokens were sent, i.e. the balance increased
/// @param value The amount of tokens that were transferred
event Transfer(address indexed from, address indexed to, uint256 value);
/// @notice Event emitted when the approval amount for the spender of a given owner's tokens changes.
/// @param owner The account that approved spending of its tokens
/// @param spender The account for which the spending allowance was modified
/// @param value The new allowance from the owner to the spender
event Approval(address indexed owner, address indexed spender, uint256 value);
}
contracts/src/v2/libraries/PonsV2BondingCurveMath.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
/**
* @title PonsV2BondingCurveMath
* @notice Constant-product bonding curve math shared by PonsV2BondingCurve, adapted
* from the BootstrapPool.sol reference (code-423n4/2025-01-iq-ai). Reserves and fee
* are passed explicitly so the same formula prices trades in either direction and can
* also price the curve's internal buyback swap.
*/
library PonsV2BondingCurveMath {
uint256 internal constant BASIS_POINTS = 10_000;
error InsufficientInputAmount();
error InsufficientOutputAmount();
error InsufficientLiquidity();
/**
* @notice Quotes the output amount for an exact input amount, net of the trade fee.
* @param amountIn Exact amount of the input asset being sold into the curve.
* @param reserveIn Curve reserve of the input asset before this trade.
* @param reserveOut Curve reserve of the output asset before this trade.
* @param feeBps Fee charged on the input amount, in basis points.
*/
function getAmountOut(uint256 amountIn, uint256 reserveIn, uint256 reserveOut, uint256 feeBps)
internal
pure
returns (uint256 amountOut)
{
if (amountIn == 0) revert InsufficientInputAmount();
if (reserveIn == 0 || reserveOut == 0) revert InsufficientLiquidity();
amountOut = _amountOut(amountIn, reserveIn, reserveOut, feeBps);
if (amountOut == 0) revert InsufficientOutputAmount();
}
/**
* @notice Same quote as `getAmountOut`, returning zero where that reverts.
* @dev For callers that treat an unpriceable trade as a condition to
* handle rather than an error, such as the curve's internal buyback,
* which folds the slice back into the creator's payout when the curve is
* too thin to execute against. Routing that case through the reverting
* variant would take the whole fee sweep down with it, stranding fees
* exactly when the curve cannot support a buyback.
*/
function quoteAmountOut(uint256 amountIn, uint256 reserveIn, uint256 reserveOut, uint256 feeBps)
internal
pure
returns (uint256 amountOut)
{
if (amountIn == 0 || reserveIn == 0 || reserveOut == 0 || feeBps >= BASIS_POINTS) return 0;
return _amountOut(amountIn, reserveIn, reserveOut, feeBps);
}
function _amountOut(uint256 amountIn, uint256 reserveIn, uint256 reserveOut, uint256 feeBps)
private
pure
returns (uint256)
{
uint256 amountInWithFee = amountIn * (BASIS_POINTS - feeBps);
uint256 numerator = amountInWithFee * reserveOut;
uint256 denominator = reserveIn * BASIS_POINTS + amountInWithFee;
return numerator / denominator;
}
/**
* @notice Quotes the input amount required for an exact output amount, net of the trade fee.
* @param amountOut Exact amount of the output asset requested from the curve.
* @param reserveIn Curve reserve of the input asset before this trade.
* @param reserveOut Curve reserve of the output asset before this trade.
* @param feeBps Fee charged on the input amount, in basis points.
*/
function getAmountIn(uint256 amountOut, uint256 reserveIn, uint256 reserveOut, uint256 feeBps)
internal
pure
returns (uint256 amountIn)
{
if (amountOut == 0) revert InsufficientOutputAmount();
if (reserveIn == 0 || reserveOut <= amountOut) revert InsufficientLiquidity();
// A full-fee trade has no input that produces output, and the
// denominator below would divide by zero rather than say so.
if (feeBps >= BASIS_POINTS) revert InsufficientLiquidity();
uint256 numerator = amountOut * reserveIn * BASIS_POINTS;
uint256 denominator = (reserveOut - amountOut) * (BASIS_POINTS - feeBps);
amountIn = numerator / denominator + 1;
}
}
contracts/lib/v4-periphery/src/interfaces/IEIP712_v4.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title IEIP712_v4
/// @notice Interface for the EIP712 contract
interface IEIP712_v4 {
/// @notice Returns the domain separator for the current chain.
/// @return bytes32 The domain separator
function DOMAIN_SEPARATOR() external view returns (bytes32);
}
contracts/lib/v4-core/src/interfaces/external/IERC6909Claims.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @notice Interface for claims over a contract balance, wrapped as a ERC6909
interface IERC6909Claims {
/*//////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////*/
event OperatorSet(address indexed owner, address indexed operator, bool approved);
event Approval(address indexed owner, address indexed spender, uint256 indexed id, uint256 amount);
event Transfer(address caller, address indexed from, address indexed to, uint256 indexed id, uint256 amount);
/*//////////////////////////////////////////////////////////////
FUNCTIONS
//////////////////////////////////////////////////////////////*/
/// @notice Owner balance of an id.
/// @param owner The address of the owner.
/// @param id The id of the token.
/// @return amount The balance of the token.
function balanceOf(address owner, uint256 id) external view returns (uint256 amount);
/// @notice Spender allowance of an id.
/// @param owner The address of the owner.
/// @param spender The address of the spender.
/// @param id The id of the token.
/// @return amount The allowance of the token.
function allowance(address owner, address spender, uint256 id) external view returns (uint256 amount);
/// @notice Checks if a spender is approved by an owner as an operator
/// @param owner The address of the owner.
/// @param spender The address of the spender.
/// @return approved The approval status.
function isOperator(address owner, address spender) external view returns (bool approved);
/// @notice Transfers an amount of an id from the caller to a receiver.
/// @param receiver The address of the receiver.
/// @param id The id of the token.
/// @param amount The amount of the token.
/// @return bool True, always, unless the function reverts
function transfer(address receiver, uint256 id, uint256 amount) external returns (bool);
/// @notice Transfers an amount of an id from a sender to a receiver.
/// @param sender The address of the sender.
/// @param receiver The address of the receiver.
/// @param id The id of the token.
/// @param amount The amount of the token.
/// @return bool True, always, unless the function reverts
function transferFrom(address sender, address receiver, uint256 id, uint256 amount) external returns (bool);
/// @notice Approves an amount of an id to a spender.
/// @param spender The address of the spender.
/// @param id The id of the token.
/// @param amount The amount of the token.
/// @return bool True, always
function approve(address spender, uint256 id, uint256 amount) external returns (bool);
/// @notice Sets or removes an operator for the caller.
/// @param operator The address of the operator.
/// @param approved The approval status.
/// @return bool True, always
function setOperator(address operator, bool approved) external returns (bool);
}
contracts/lib/v4-core/src/libraries/TickMath.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {BitMath} from "./BitMath.sol";
import {CustomRevert} from "./CustomRevert.sol";
/// @title Math library for computing sqrt prices from ticks and vice versa
/// @notice Computes sqrt price for ticks of size 1.0001, i.e. sqrt(1.0001^tick) as fixed point Q64.96 numbers. Supports
/// prices between 2**-128 and 2**128
library TickMath {
using CustomRevert for bytes4;
/// @notice Thrown when the tick passed to #getSqrtPriceAtTick is not between MIN_TICK and MAX_TICK
error InvalidTick(int24 tick);
/// @notice Thrown when the price passed to #getTickAtSqrtPrice does not correspond to a price between MIN_TICK and MAX_TICK
error InvalidSqrtPrice(uint160 sqrtPriceX96);
/// @dev The minimum tick that may be passed to #getSqrtPriceAtTick computed from log base 1.0001 of 2**-128
/// @dev If ever MIN_TICK and MAX_TICK are not centered around 0, the absTick logic in getSqrtPriceAtTick cannot be used
int24 internal constant MIN_TICK = -887272;
/// @dev The maximum tick that may be passed to #getSqrtPriceAtTick computed from log base 1.0001 of 2**128
/// @dev If ever MIN_TICK and MAX_TICK are not centered around 0, the absTick logic in getSqrtPriceAtTick cannot be used
int24 internal constant MAX_TICK = 887272;
/// @dev The minimum tick spacing value drawn from the range of type int16 that is greater than 0, i.e. min from the range [1, 32767]
int24 internal constant MIN_TICK_SPACING = 1;
/// @dev The maximum tick spacing value drawn from the range of type int16, i.e. max from the range [1, 32767]
int24 internal constant MAX_TICK_SPACING = type(int16).max;
/// @dev The minimum value that can be returned from #getSqrtPriceAtTick. Equivalent to getSqrtPriceAtTick(MIN_TICK)
uint160 internal constant MIN_SQRT_PRICE = 4295128739;
/// @dev The maximum value that can be returned from #getSqrtPriceAtTick. Equivalent to getSqrtPriceAtTick(MAX_TICK)
uint160 internal constant MAX_SQRT_PRICE = 1461446703485210103287273052203988822378723970342;
/// @dev A threshold used for optimized bounds check, equals `MAX_SQRT_PRICE - MIN_SQRT_PRICE - 1`
uint160 internal constant MAX_SQRT_PRICE_MINUS_MIN_SQRT_PRICE_MINUS_ONE =
1461446703485210103287273052203988822378723970342 - 4295128739 - 1;
/// @notice Given a tickSpacing, compute the maximum usable tick
function maxUsableTick(int24 tickSpacing) internal pure returns (int24) {
unchecked {
return (MAX_TICK / tickSpacing) * tickSpacing;
}
}
/// @notice Given a tickSpacing, compute the minimum usable tick
function minUsableTick(int24 tickSpacing) internal pure returns (int24) {
unchecked {
return (MIN_TICK / tickSpacing) * tickSpacing;
}
}
/// @notice Calculates sqrt(1.0001^tick) * 2^96
/// @dev Throws if |tick| > max tick
/// @param tick The input tick for the above formula
/// @return sqrtPriceX96 A Fixed point Q64.96 number representing the sqrt of the price of the two assets (currency1/currency0)
/// at the given tick
function getSqrtPriceAtTick(int24 tick) internal pure returns (uint160 sqrtPriceX96) {
unchecked {
uint256 absTick;
assembly ("memory-safe") {
tick := signextend(2, tick)
// mask = 0 if tick >= 0 else -1 (all 1s)
let mask := sar(255, tick)
// if tick >= 0, |tick| = tick = 0 ^ tick
// if tick < 0, |tick| = ~~|tick| = ~(-|tick| - 1) = ~(tick - 1) = (-1) ^ (tick - 1)
// either way, |tick| = mask ^ (tick + mask)
absTick := xor(mask, add(mask, tick))
}
if (absTick > uint256(int256(MAX_TICK))) InvalidTick.selector.revertWith(tick);
// The tick is decomposed into bits, and for each bit with index i that is set, the product of 1/sqrt(1.0001^(2^i))
// is calculated (using Q128.128). The constants used for this calculation are rounded to the nearest integer
// Equivalent to:
// price = absTick & 0x1 != 0 ? 0xfffcb933bd6fad37aa2d162d1a594001 : 0x100000000000000000000000000000000;
// or price = int(2**128 / sqrt(1.0001)) if (absTick & 0x1) else 1 << 128
uint256 price;
assembly ("memory-safe") {
price := xor(shl(128, 1), mul(xor(shl(128, 1), 0xfffcb933bd6fad37aa2d162d1a594001), and(absTick, 0x1)))
}
if (absTick & 0x2 != 0) price = (price * 0xfff97272373d413259a46990580e213a) >> 128;
if (absTick & 0x4 != 0) price = (price * 0xfff2e50f5f656932ef12357cf3c7fdcc) >> 128;
if (absTick & 0x8 != 0) price = (price * 0xffe5caca7e10e4e61c3624eaa0941cd0) >> 128;
if (absTick & 0x10 != 0) price = (price * 0xffcb9843d60f6159c9db58835c926644) >> 128;
if (absTick & 0x20 != 0) price = (price * 0xff973b41fa98c081472e6896dfb254c0) >> 128;
if (absTick & 0x40 != 0) price = (price * 0xff2ea16466c96a3843ec78b326b52861) >> 128;
if (absTick & 0x80 != 0) price = (price * 0xfe5dee046a99a2a811c461f1969c3053) >> 128;
if (absTick & 0x100 != 0) price = (price * 0xfcbe86c7900a88aedcffc83b479aa3a4) >> 128;
if (absTick & 0x200 != 0) price = (price * 0xf987a7253ac413176f2b074cf7815e54) >> 128;
if (absTick & 0x400 != 0) price = (price * 0xf3392b0822b70005940c7a398e4b70f3) >> 128;
if (absTick & 0x800 != 0) price = (price * 0xe7159475a2c29b7443b29c7fa6e889d9) >> 128;
if (absTick & 0x1000 != 0) price = (price * 0xd097f3bdfd2022b8845ad8f792aa5825) >> 128;
if (absTick & 0x2000 != 0) price = (price * 0xa9f746462d870fdf8a65dc1f90e061e5) >> 128;
if (absTick & 0x4000 != 0) price = (price * 0x70d869a156d2a1b890bb3df62baf32f7) >> 128;
if (absTick & 0x8000 != 0) price = (price * 0x31be135f97d08fd981231505542fcfa6) >> 128;
if (absTick & 0x10000 != 0) price = (price * 0x9aa508b5b7a84e1c677de54f3e99bc9) >> 128;
if (absTick & 0x20000 != 0) price = (price * 0x5d6af8dedb81196699c329225ee604) >> 128;
if (absTick & 0x40000 != 0) price = (price * 0x2216e584f5fa1ea926041bedfe98) >> 128;
if (absTick & 0x80000 != 0) price = (price * 0x48a170391f7dc42444e8fa2) >> 128;
assembly ("memory-safe") {
// if (tick > 0) price = type(uint256).max / price;
if sgt(tick, 0) { price := div(not(0), price) }
// this divides by 1<<32 rounding up to go from a Q128.128 to a Q128.96.
// we then downcast because we know the result always fits within 160 bits due to our tick input constraint
// we round up in the division so getTickAtSqrtPrice of the output price is always consistent
// `sub(shl(32, 1), 1)` is `type(uint32).max`
// `price + type(uint32).max` will not overflow because `price` fits in 192 bits
sqrtPriceX96 := shr(32, add(price, sub(shl(32, 1), 1)))
}
}
}
/// @notice Calculates the greatest tick value such that getSqrtPriceAtTick(tick) <= sqrtPriceX96
/// @dev Throws in case sqrtPriceX96 < MIN_SQRT_PRICE, as MIN_SQRT_PRICE is the lowest value getSqrtPriceAtTick may
/// ever return.
/// @param sqrtPriceX96 The sqrt price for which to compute the tick as a Q64.96
/// @return tick The greatest tick for which the getSqrtPriceAtTick(tick) is less than or equal to the input sqrtPriceX96
function getTickAtSqrtPrice(uint160 sqrtPriceX96) internal pure returns (int24 tick) {
unchecked {
// Equivalent: if (sqrtPriceX96 < MIN_SQRT_PRICE || sqrtPriceX96 >= MAX_SQRT_PRICE) revert InvalidSqrtPrice();
// second inequality must be >= because the price can never reach the price at the max tick
// if sqrtPriceX96 < MIN_SQRT_PRICE, the `sub` underflows and `gt` is true
// if sqrtPriceX96 >= MAX_SQRT_PRICE, sqrtPriceX96 - MIN_SQRT_PRICE > MAX_SQRT_PRICE - MIN_SQRT_PRICE - 1
if ((sqrtPriceX96 - MIN_SQRT_PRICE) > MAX_SQRT_PRICE_MINUS_MIN_SQRT_PRICE_MINUS_ONE) {
InvalidSqrtPrice.selector.revertWith(sqrtPriceX96);
}
uint256 price = uint256(sqrtPriceX96) << 32;
uint256 r = price;
uint256 msb = BitMath.mostSignificantBit(r);
if (msb >= 128) r = price >> (msb - 127);
else r = price << (127 - msb);
int256 log_2 = (int256(msb) - 128) << 64;
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(63, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(62, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(61, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(60, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(59, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(58, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(57, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(56, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(55, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(54, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(53, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(52, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(51, f))
r := shr(f, r)
}
assembly ("memory-safe") {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(50, f))
}
int256 log_sqrt10001 = log_2 * 255738958999603826347141; // Q22.128 number
// Magic number represents the ceiling of the maximum value of the error when approximating log_sqrt10001(x)
int24 tickLow = int24((log_sqrt10001 - 3402992956809132418596140100660247210) >> 128);
// Magic number represents the minimum value of the error when approximating log_sqrt10001(x), when
// sqrtPrice is from the range (2^-64, 2^64). This is safe as MIN_SQRT_PRICE is more than 2^-64. If MIN_SQRT_PRICE
// is changed, this may need to be changed too
int24 tickHi = int24((log_sqrt10001 + 291339464771989622907027621153398088495) >> 128);
tick = tickLow == tickHi ? tickLow : getSqrtPriceAtTick(tickHi) <= sqrtPriceX96 ? tickHi : tickLow;
}
}
}
contracts/lib/v4-core/src/libraries/ParseBytes.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @notice Parses bytes returned from hooks and the byte selector used to check return selectors from hooks.
/// @dev parseSelector also is used to parse the expected selector
/// For parsing hook returns, note that all hooks return either bytes4 or (bytes4, 32-byte-delta) or (bytes4, 32-byte-delta, uint24).
library ParseBytes {
function parseSelector(bytes memory result) internal pure returns (bytes4 selector) {
// equivalent: (selector,) = abi.decode(result, (bytes4, int256));
assembly ("memory-safe") {
selector := mload(add(result, 0x20))
}
}
function parseFee(bytes memory result) internal pure returns (uint24 lpFee) {
// equivalent: (,, lpFee) = abi.decode(result, (bytes4, int256, uint24));
assembly ("memory-safe") {
lpFee := mload(add(result, 0x60))
}
}
function parseReturnDelta(bytes memory result) internal pure returns (int256 hookReturn) {
// equivalent: (, hookReturnDelta) = abi.decode(result, (bytes4, int256));
assembly ("memory-safe") {
hookReturn := mload(add(result, 0x40))
}
}
}
contracts/lib/v4-core/src/types/Slot0.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev Slot0 is a packed version of solidity structure.
* Using the packaged version saves gas by not storing the structure fields in memory slots.
*
* Layout:
* 24 bits empty | 24 bits lpFee | 12 bits protocolFee 1->0 | 12 bits protocolFee 0->1 | 24 bits tick | 160 bits sqrtPriceX96
*
* Fields in the direction from the least significant bit:
*
* The current price
* uint160 sqrtPriceX96;
*
* The current tick
* int24 tick;
*
* Protocol fee, expressed in hundredths of a bip, upper 12 bits are for 1->0, and the lower 12 are for 0->1
* the maximum is 1000 - meaning the maximum protocol fee is 0.1%
* the protocolFee is taken from the input first, then the lpFee is taken from the remaining input
* uint24 protocolFee;
*
* The current LP fee of the pool. If the pool is dynamic, this does not include the dynamic fee flag.
* uint24 lpFee;
*/
type Slot0 is bytes32;
using Slot0Library for Slot0 global;
/// @notice Library for getting and setting values in the Slot0 type
library Slot0Library {
uint160 internal constant MASK_160_BITS = 0x00FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF;
uint24 internal constant MASK_24_BITS = 0xFFFFFF;
uint8 internal constant TICK_OFFSET = 160;
uint8 internal constant PROTOCOL_FEE_OFFSET = 184;
uint8 internal constant LP_FEE_OFFSET = 208;
// #### GETTERS ####
function sqrtPriceX96(Slot0 _packed) internal pure returns (uint160 _sqrtPriceX96) {
assembly ("memory-safe") {
_sqrtPriceX96 := and(MASK_160_BITS, _packed)
}
}
function tick(Slot0 _packed) internal pure returns (int24 _tick) {
assembly ("memory-safe") {
_tick := signextend(2, shr(TICK_OFFSET, _packed))
}
}
function protocolFee(Slot0 _packed) internal pure returns (uint24 _protocolFee) {
assembly ("memory-safe") {
_protocolFee := and(MASK_24_BITS, shr(PROTOCOL_FEE_OFFSET, _packed))
}
}
function lpFee(Slot0 _packed) internal pure returns (uint24 _lpFee) {
assembly ("memory-safe") {
_lpFee := and(MASK_24_BITS, shr(LP_FEE_OFFSET, _packed))
}
}
// #### SETTERS ####
function setSqrtPriceX96(Slot0 _packed, uint160 _sqrtPriceX96) internal pure returns (Slot0 _result) {
assembly ("memory-safe") {
_result := or(and(not(MASK_160_BITS), _packed), and(MASK_160_BITS, _sqrtPriceX96))
}
}
function setTick(Slot0 _packed, int24 _tick) internal pure returns (Slot0 _result) {
assembly ("memory-safe") {
_result := or(and(not(shl(TICK_OFFSET, MASK_24_BITS)), _packed), shl(TICK_OFFSET, and(MASK_24_BITS, _tick)))
}
}
function setProtocolFee(Slot0 _packed, uint24 _protocolFee) internal pure returns (Slot0 _result) {
assembly ("memory-safe") {
_result :=
or(
and(not(shl(PROTOCOL_FEE_OFFSET, MASK_24_BITS)), _packed),
shl(PROTOCOL_FEE_OFFSET, and(MASK_24_BITS, _protocolFee))
)
}
}
function setLpFee(Slot0 _packed, uint24 _lpFee) internal pure returns (Slot0 _result) {
assembly ("memory-safe") {
_result :=
or(and(not(shl(LP_FEE_OFFSET, MASK_24_BITS)), _packed), shl(LP_FEE_OFFSET, and(MASK_24_BITS, _lpFee)))
}
}
}
contracts/lib/v4-core/src/interfaces/callback/IUnlockCallback.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @notice Interface for the callback executed when an address unlocks the pool manager
interface IUnlockCallback {
/// @notice Called by the pool manager on `msg.sender` when the manager is unlocked
/// @param data The data that was passed to the call to unlock
/// @return Any data that you want to be returned from the unlock call
function unlockCallback(bytes calldata data) external returns (bytes memory);
}
contracts/lib/v4-periphery/src/interfaces/IPoolInitializer_v4.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
/// @title IPoolInitializer_v4
/// @notice Interface for the PoolInitializer_v4 contract
interface IPoolInitializer_v4 {
/// @notice Initialize a Uniswap v4 Pool
/// @dev If the pool is already initialized, this function will not revert and just return type(int24).max
/// @param key The PoolKey of the pool to initialize
/// @param sqrtPriceX96 The initial starting price of the pool, expressed as a sqrtPriceX96
/// @return The current tick of the pool, or type(int24).max if the pool creation failed, or the pool already existed
function initializePool(PoolKey calldata key, uint160 sqrtPriceX96) external payable returns (int24);
}
contracts/lib/openzeppelin-contracts/contracts/interfaces/IERC20.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC20.sol)
pragma solidity >=0.4.16;
import {IERC20} from "../token/ERC20/IERC20.sol";
contracts/src/v2/PonsV2GraduationExecutor.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
import {TickMath} from "@uniswap/v4-core/src/libraries/TickMath.sol";
import {IPositionManager} from "@uniswap/v4-periphery/src/interfaces/IPositionManager.sol";
import {Actions} from "@uniswap/v4-periphery/src/libraries/Actions.sol";
import {LiquidityAmounts} from "@uniswap/v4-periphery/src/libraries/LiquidityAmounts.sol";
import {IAllowanceTransfer} from "permit2/src/interfaces/IAllowanceTransfer.sol";
import {PonsV2LaunchLocker} from "./PonsV2LaunchLocker.sol";
/**
* @title PonsV2GraduationExecutor
* @notice Performs the two heaviest steps of pons v2 graduation on
* PonsV2LaunchFactory's behalf: swapping swept ETH for a non-native
* pairToken, and minting the full-range Uniswap V4 position. Split out into
* its own contract purely so PonsV2LaunchFactory's own bytecode stays under
* EIP-170's 24576-byte deployed-code limit: the swap-router branching,
* Permit2 approval dance, PositionManager action encoding, and post-mint
* dust sweep account for a large share of that size on their own. The
* factory transfers exactly the assets a mint needs here immediately before
* calling in, so this contract never holds a balance between transactions.
*/
contract PonsV2GraduationExecutor {
using SafeERC20 for IERC20;
uint256 private constant MINT_DEADLINE_WINDOW = 300;
error NotFactory();
error ZeroAddress();
error FeeTransferFailed();
error SlippageExceeded(uint256 actual, uint256 minimum);
error MintAmountOverflow();
event GraduationDustSwept(address indexed launchToken, address indexed currency, uint256 amount);
event GraduationDustRetained(address indexed launchToken, address indexed currency, uint256 amount);
IPositionManager public immutable positionManager;
IAllowanceTransfer public immutable permit2;
PonsV2LaunchLocker public immutable locker;
address public immutable factory;
modifier onlyFactory() {
if (msg.sender != factory) revert NotFactory();
_;
}
constructor(
IPositionManager positionManager_,
IAllowanceTransfer permit2_,
PonsV2LaunchLocker locker_,
address factory_
) {
if (address(positionManager_) == address(0) || address(permit2_) == address(0)) {
revert ZeroAddress();
}
if (address(locker_) == address(0) || factory_ == address(0)) revert ZeroAddress();
positionManager = positionManager_;
permit2 = permit2_;
locker = locker_;
factory = factory_;
}
/**
* @notice Mints a full-range position directly to the locker from
* balances the factory just transferred here, then forwards any
* post-mint rounding dust on either leg to `protocolFeeRecipient`.
* @dev Full-range liquidity is derived here from the pool's starting
* price and the target amounts, rather than by the factory, because the
* tick and liquidity math inlines a large amount of code that the
* factory has no room for. The exact amounts SETTLE_PAIR ends up pulling
* almost always round down slightly against those targets, so the
* post-mint sweep prevents dust piling up here.
*/
function mintFullRangePosition(
address launchToken,
PoolKey calldata key,
int24 tickLower,
int24 tickUpper,
uint160 sqrtPriceX96,
uint256 amount0Max,
uint256 amount1Max,
Currency currency0,
Currency currency1,
address protocolFeeRecipient
) external payable onlyFactory {
// MINT_POSITION takes both maxima as uint128, so a larger amount would
// truncate and settle a position that does not match the reserves the
// curve was drained of. The factory's preflight already rejects these,
// but silent truncation is not a property worth delegating to a
// caller.
if (amount0Max > type(uint128).max || amount1Max > type(uint128).max) revert MintAmountOverflow();
uint128 liquidity = LiquidityAmounts.getLiquidityForAmounts(
sqrtPriceX96,
TickMath.getSqrtPriceAtTick(tickLower),
TickMath.getSqrtPriceAtTick(tickUpper),
amount0Max,
amount1Max
);
bool hasNative = currency0.isAddressZero();
if (!hasNative) _approvePermit2(Currency.unwrap(currency0), amount0Max);
_approvePermit2(Currency.unwrap(currency1), amount1Max);
bytes memory actions = hasNative
? abi.encodePacked(uint8(Actions.MINT_POSITION), uint8(Actions.SETTLE_PAIR), uint8(Actions.SWEEP))
: abi.encodePacked(uint8(Actions.MINT_POSITION), uint8(Actions.SETTLE_PAIR));
bytes[] memory params = new bytes[](hasNative ? 3 : 2);
params[0] = abi.encode(
key,
tickLower,
tickUpper,
uint256(liquidity),
// forge-lint: disable-next-line(unsafe-typecast)
uint128(amount0Max),
// forge-lint: disable-next-line(unsafe-typecast)
uint128(amount1Max),
address(locker),
bytes("")
);
params[1] = abi.encode(currency0, currency1);
if (hasNative) params[2] = abi.encode(currency0, address(this));
positionManager.modifyLiquidities{value: msg.value}(
abi.encode(actions, params), block.timestamp + MINT_DEADLINE_WINDOW
);
_sweepResidualBalance(launchToken, currency0, protocolFeeRecipient);
_sweepResidualBalance(launchToken, currency1, protocolFeeRecipient);
}
/**
* @dev Grants Permit2 a standard ERC-20 approval, then records a
* matching Permit2 allowance for the PositionManager, the two-step
* approval Permit2-based transfers always require from the token owner.
*/
function _approvePermit2(address token, uint256 amount) private {
IERC20(token).forceApprove(address(permit2), amount);
// Amount is a real token balance the factory just transferred here, always far below uint160's range.
// forge-lint: disable-next-line(unsafe-typecast)
permit2.approve(
token, address(positionManager), uint160(amount), uint48(block.timestamp + MINT_DEADLINE_WINDOW)
);
}
/**
* @dev Sends any leftover balance of `currency` held by this contract to
* the protocol treasury, or to the locker when the currency is the launch
* token itself. Covers both native dust returned by the position
* manager's own SWEEP action and ERC-20 dust that was simply never pulled
* out via Permit2 in the first place.
*
* Routing the launch-token leg to the locker keeps the guarantee that
* supply which did not reach the pool never enters circulation. Paying it
* to the treasury instead would make that guarantee approximate, and
* would attribute one launch's retained dust to whichever launch
* graduates next, since this sweeps the whole balance rather than a
* per-graduation delta.
*
* A failed sweep is reported rather than thrown. Disposing of rounding
* dust is incidental to seeding the pool, and letting it revert would
* leave a launch that has already surrendered its reserves unable to ever
* complete. Whatever cannot be sent stays here and is carried out by the
* next graduation that sweeps the same currency.
*/
function _sweepResidualBalance(address launchToken, Currency currency, address recipient) private {
uint256 amount = currency.isAddressZero()
? address(this).balance
: IERC20(Currency.unwrap(currency)).balanceOf(address(this));
if (amount == 0) return;
if (Currency.unwrap(currency) == launchToken) recipient = address(locker);
bool swept;
if (currency.isAddressZero()) {
(swept,) = payable(recipient).call{value: amount}("");
} else {
// A low-level call rather than try/catch around IERC20.transfer.
// `catch` covers a revert inside the callee, but not a failure to
// decode what it returned, and that decode happens in this frame
// and propagates. A token that transfers successfully while
// returning no data would therefore revert the whole graduation,
// which is precisely the token class the non-throwing design here
// exists to tolerate.
(bool ok, bytes memory ret) =
Currency.unwrap(currency).call(abi.encodeCall(IERC20.transfer, (recipient, amount)));
swept = ok && (ret.length == 0 || (ret.length == 32 && abi.decode(ret, (bool))));
}
if (swept) {
emit GraduationDustSwept(launchToken, Currency.unwrap(currency), amount);
} else {
emit GraduationDustRetained(launchToken, Currency.unwrap(currency), amount);
}
}
/**
* @notice Accepts native ETH the factory forwards for a mint and any
* dust the PositionManager's own SWEEP action returns here.
*/
receive() external payable {}
}
contracts/lib/v4-core/src/libraries/FixedPoint128.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title FixedPoint128
/// @notice A library for handling binary fixed point numbers, see https://en.wikipedia.org/wiki/Q_(number_format)
library FixedPoint128 {
uint256 internal constant Q128 = 0x100000000000000000000000000000000;
}
contracts/lib/openzeppelin-contracts/contracts/access/Ownable.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^0.8.20;
import {Context} from "../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is set to the address provided by the deployer. This can
* later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
/**
* @dev The caller account is not authorized to perform an operation.
*/
error OwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/
error OwnableInvalidOwner(address owner);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/
constructor(address initialOwner) {
if (initialOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
if (newOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
contracts/lib/v4-core/src/libraries/FullMath.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title Contains 512-bit math functions
/// @notice Facilitates multiplication and division that can have overflow of an intermediate value without any loss of precision
/// @dev Handles "phantom overflow" i.e., allows multiplication and division where an intermediate value overflows 256 bits
library FullMath {
/// @notice Calculates floor(a×b÷denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
/// @param a The multiplicand
/// @param b The multiplier
/// @param denominator The divisor
/// @return result The 256-bit result
/// @dev Credit to Remco Bloemen under MIT license https://xn--2-umb.com/21/muldiv
function mulDiv(uint256 a, uint256 b, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
// 512-bit multiply [prod1 prod0] = a * b
// Compute the product mod 2**256 and mod 2**256 - 1
// then use the Chinese Remainder Theorem to reconstruct
// the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2**256 + prod0
uint256 prod0 = a * b; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly ("memory-safe") {
let mm := mulmod(a, b, not(0))
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Make sure the result is less than 2**256.
// Also prevents denominator == 0
require(denominator > prod1);
// Handle non-overflow cases, 256 by 256 division
if (prod1 == 0) {
assembly ("memory-safe") {
result := div(prod0, denominator)
}
return result;
}
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0]
// Compute remainder using mulmod
uint256 remainder;
assembly ("memory-safe") {
remainder := mulmod(a, b, denominator)
}
// Subtract 256 bit number from 512 bit number
assembly ("memory-safe") {
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
// Factor powers of two out of denominator
// Compute largest power of two divisor of denominator.
// Always >= 1.
uint256 twos = (0 - denominator) & denominator;
// Divide denominator by power of two
assembly ("memory-safe") {
denominator := div(denominator, twos)
}
// Divide [prod1 prod0] by the factors of two
assembly ("memory-safe") {
prod0 := div(prod0, twos)
}
// Shift in bits from prod1 into prod0. For this we need
// to flip `twos` such that it is 2**256 / twos.
// If twos is zero, then it becomes one
assembly ("memory-safe") {
twos := add(div(sub(0, twos), twos), 1)
}
prod0 |= prod1 * twos;
// Invert denominator mod 2**256
// Now that denominator is an odd number, it has an inverse
// modulo 2**256 such that denominator * inv = 1 mod 2**256.
// Compute the inverse by starting with a seed that is correct
// correct for four bits. That is, denominator * inv = 1 mod 2**4
uint256 inv = (3 * denominator) ^ 2;
// Now use Newton-Raphson iteration to improve the precision.
// Thanks to Hensel's lifting lemma, this also works in modular
// arithmetic, doubling the correct bits in each step.
inv *= 2 - denominator * inv; // inverse mod 2**8
inv *= 2 - denominator * inv; // inverse mod 2**16
inv *= 2 - denominator * inv; // inverse mod 2**32
inv *= 2 - denominator * inv; // inverse mod 2**64
inv *= 2 - denominator * inv; // inverse mod 2**128
inv *= 2 - denominator * inv; // inverse mod 2**256
// Because the division is now exact we can divide by multiplying
// with the modular inverse of denominator. This will give us the
// correct result modulo 2**256. Since the preconditions guarantee
// that the outcome is less than 2**256, this is the final result.
// We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inv;
return result;
}
}
/// @notice Calculates ceil(a×b÷denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
/// @param a The multiplicand
/// @param b The multiplier
/// @param denominator The divisor
/// @return result The 256-bit result
function mulDivRoundingUp(uint256 a, uint256 b, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
result = mulDiv(a, b, denominator);
if (mulmod(a, b, denominator) != 0) {
require(++result > 0);
}
}
}
}
contracts/lib/v4-core/src/libraries/FixedPoint96.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title FixedPoint96
/// @notice A library for handling binary fixed point numbers, see https://en.wikipedia.org/wiki/Q_(number_format)
/// @dev Used in SqrtPriceMath.sol
library FixedPoint96 {
uint8 internal constant RESOLUTION = 96;
uint256 internal constant Q96 = 0x1000000000000000000000000;
}
contracts/lib/v4-core/src/types/BeforeSwapDelta.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
// Return type of the beforeSwap hook.
// Upper 128 bits is the delta in specified tokens. Lower 128 bits is delta in unspecified tokens (to match the afterSwap hook)
type BeforeSwapDelta is int256;
// Creates a BeforeSwapDelta from specified and unspecified
function toBeforeSwapDelta(int128 deltaSpecified, int128 deltaUnspecified)
pure
returns (BeforeSwapDelta beforeSwapDelta)
{
assembly ("memory-safe") {
beforeSwapDelta := or(shl(128, deltaSpecified), and(sub(shl(128, 1), 1), deltaUnspecified))
}
}
/// @notice Library for getting the specified and unspecified deltas from the BeforeSwapDelta type
library BeforeSwapDeltaLibrary {
/// @notice A BeforeSwapDelta of 0
BeforeSwapDelta public constant ZERO_DELTA = BeforeSwapDelta.wrap(0);
/// extracts int128 from the upper 128 bits of the BeforeSwapDelta
/// returned by beforeSwap
function getSpecifiedDelta(BeforeSwapDelta delta) internal pure returns (int128 deltaSpecified) {
assembly ("memory-safe") {
deltaSpecified := sar(128, delta)
}
}
/// extracts int128 from the lower 128 bits of the BeforeSwapDelta
/// returned by beforeSwap and afterSwap
function getUnspecifiedDelta(BeforeSwapDelta delta) internal pure returns (int128 deltaUnspecified) {
assembly ("memory-safe") {
deltaUnspecified := signextend(15, delta)
}
}
}
contracts/lib/v4-hooks-public/src/base/BaseHook.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {Hooks} from "@uniswap/v4-core/src/libraries/Hooks.sol";
import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
import {IHooks} from "@uniswap/v4-core/src/interfaces/IHooks.sol";
import {BalanceDelta} from "@uniswap/v4-core/src/types/BalanceDelta.sol";
import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
import {BeforeSwapDelta} from "@uniswap/v4-core/src/types/BeforeSwapDelta.sol";
import {ImmutableState} from "@uniswap/v4-periphery/src/base/ImmutableState.sol";
import {ModifyLiquidityParams, SwapParams} from "@uniswap/v4-core/src/types/PoolOperation.sol";
/// @title Base Hook
/// @notice abstract contract for hook implementations
abstract contract BaseHook is IHooks, ImmutableState {
error HookNotImplemented();
constructor(IPoolManager _manager) ImmutableState(_manager) {
validateHookAddress(this);
}
/// @notice Returns a struct of permissions to signal which hook functions are to be implemented
/// @dev Used at deployment to validate the address correctly represents the expected permissions
/// @return Permissions struct
function getHookPermissions() public pure virtual returns (Hooks.Permissions memory);
/// @notice Validates the deployed hook address agrees with the expected permissions of the hook
/// @dev this function is virtual so that we can override it during testing,
/// which allows us to deploy an implementation to any address
/// and then etch the bytecode into the correct address
function validateHookAddress(BaseHook _this) internal pure virtual {
Hooks.validateHookPermissions(_this, getHookPermissions());
}
/// @inheritdoc IHooks
function beforeInitialize(address sender, PoolKey calldata key, uint160 sqrtPriceX96)
external
onlyPoolManager
returns (bytes4)
{
return _beforeInitialize(sender, key, sqrtPriceX96);
}
function _beforeInitialize(address, PoolKey calldata, uint160) internal virtual returns (bytes4) {
revert HookNotImplemented();
}
/// @inheritdoc IHooks
function afterInitialize(address sender, PoolKey calldata key, uint160 sqrtPriceX96, int24 tick)
external
onlyPoolManager
returns (bytes4)
{
return _afterInitialize(sender, key, sqrtPriceX96, tick);
}
function _afterInitialize(address, PoolKey calldata, uint160, int24) internal virtual returns (bytes4) {
revert HookNotImplemented();
}
/// @inheritdoc IHooks
function beforeAddLiquidity(
address sender,
PoolKey calldata key,
ModifyLiquidityParams calldata params,
bytes calldata hookData
) external onlyPoolManager returns (bytes4) {
return _beforeAddLiquidity(sender, key, params, hookData);
}
function _beforeAddLiquidity(address, PoolKey calldata, ModifyLiquidityParams calldata, bytes calldata)
internal
virtual
returns (bytes4)
{
revert HookNotImplemented();
}
/// @inheritdoc IHooks
function beforeRemoveLiquidity(
address sender,
PoolKey calldata key,
ModifyLiquidityParams calldata params,
bytes calldata hookData
) external onlyPoolManager returns (bytes4) {
return _beforeRemoveLiquidity(sender, key, params, hookData);
}
function _beforeRemoveLiquidity(address, PoolKey calldata, ModifyLiquidityParams calldata, bytes calldata)
internal
virtual
returns (bytes4)
{
revert HookNotImplemented();
}
/// @inheritdoc IHooks
function afterAddLiquidity(
address sender,
PoolKey calldata key,
ModifyLiquidityParams calldata params,
BalanceDelta delta,
BalanceDelta feesAccrued,
bytes calldata hookData
) external onlyPoolManager returns (bytes4, BalanceDelta) {
return _afterAddLiquidity(sender, key, params, delta, feesAccrued, hookData);
}
function _afterAddLiquidity(
address,
PoolKey calldata,
ModifyLiquidityParams calldata,
BalanceDelta,
BalanceDelta,
bytes calldata
) internal virtual returns (bytes4, BalanceDelta) {
revert HookNotImplemented();
}
/// @inheritdoc IHooks
function afterRemoveLiquidity(
address sender,
PoolKey calldata key,
ModifyLiquidityParams calldata params,
BalanceDelta delta,
BalanceDelta feesAccrued,
bytes calldata hookData
) external onlyPoolManager returns (bytes4, BalanceDelta) {
return _afterRemoveLiquidity(sender, key, params, delta, feesAccrued, hookData);
}
function _afterRemoveLiquidity(
address,
PoolKey calldata,
ModifyLiquidityParams calldata,
BalanceDelta,
BalanceDelta,
bytes calldata
) internal virtual returns (bytes4, BalanceDelta) {
revert HookNotImplemented();
}
/// @inheritdoc IHooks
function beforeSwap(address sender, PoolKey calldata key, SwapParams calldata params, bytes calldata hookData)
external
onlyPoolManager
returns (bytes4, BeforeSwapDelta, uint24)
{
return _beforeSwap(sender, key, params, hookData);
}
function _beforeSwap(address, PoolKey calldata, SwapParams calldata, bytes calldata)
internal
virtual
returns (bytes4, BeforeSwapDelta, uint24)
{
revert HookNotImplemented();
}
/// @inheritdoc IHooks
function afterSwap(
address sender,
PoolKey calldata key,
SwapParams calldata params,
BalanceDelta delta,
bytes calldata hookData
) external onlyPoolManager returns (bytes4, int128) {
return _afterSwap(sender, key, params, delta, hookData);
}
function _afterSwap(address, PoolKey calldata, SwapParams calldata, BalanceDelta, bytes calldata)
internal
virtual
returns (bytes4, int128)
{
revert HookNotImplemented();
}
/// @inheritdoc IHooks
function beforeDonate(
address sender,
PoolKey calldata key,
uint256 amount0,
uint256 amount1,
bytes calldata hookData
) external onlyPoolManager returns (bytes4) {
return _beforeDonate(sender, key, amount0, amount1, hookData);
}
function _beforeDonate(address, PoolKey calldata, uint256, uint256, bytes calldata)
internal
virtual
returns (bytes4)
{
revert HookNotImplemented();
}
/// @inheritdoc IHooks
function afterDonate(
address sender,
PoolKey calldata key,
uint256 amount0,
uint256 amount1,
bytes calldata hookData
) external onlyPoolManager returns (bytes4) {
return _afterDonate(sender, key, amount0, amount1, hookData);
}
function _afterDonate(address, PoolKey calldata, uint256, uint256, bytes calldata)
internal
virtual
returns (bytes4)
{
revert HookNotImplemented();
}
}
contracts/lib/openzeppelin-contracts/contracts/utils/Create2.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (utils/Create2.sol)
pragma solidity ^0.8.20;
import {Errors} from "./Errors.sol";
import {LowLevelCall} from "./LowLevelCall.sol";
/**
* @dev Helper to make usage of the `CREATE2` EVM opcode easier and safer.
* `CREATE2` can be used to compute in advance the address where a smart
* contract will be deployed, which allows for interesting new mechanisms known
* as 'counterfactual interactions'.
*
* See the https://eips.ethereum.org/EIPS/eip-1014#motivation[EIP] for more
* information.
*/
library Create2 {
/**
* @dev There's no code to deploy.
*/
error Create2EmptyBytecode();
/**
* @dev Deploys a contract using `CREATE2`. The address where the contract
* will be deployed can be known in advance via {computeAddress}.
*
* The bytecode for a contract can be obtained from Solidity with
* `type(contractName).creationCode`.
*
* Requirements:
*
* - `bytecode` must not be empty.
* - `salt` must have not been used for `bytecode` already.
* - the factory must have a balance of at least `amount`.
* - if `amount` is non-zero, `bytecode` must have a `payable` constructor.
*/
function deploy(uint256 amount, bytes32 salt, bytes memory bytecode) internal returns (address addr) {
if (address(this).balance < amount) {
revert Errors.InsufficientBalance(address(this).balance, amount);
}
if (bytecode.length == 0) {
revert Create2EmptyBytecode();
}
assembly ("memory-safe") {
addr := create2(amount, add(bytecode, 0x20), mload(bytecode), salt)
}
if (addr == address(0)) {
if (LowLevelCall.returnDataSize() == 0) {
revert Errors.FailedDeployment();
} else {
LowLevelCall.bubbleRevert();
}
}
}
/**
* @dev Returns the address where a contract will be stored if deployed via {deploy}. Any change in the
* `bytecodeHash` or `salt` will result in a new destination address.
*/
function computeAddress(bytes32 salt, bytes32 bytecodeHash) internal view returns (address) {
return computeAddress(salt, bytecodeHash, address(this));
}
/**
* @dev Returns the address where a contract will be stored if deployed via {deploy} from a contract located at
* `deployer`. If `deployer` is this contract's address, returns the same value as {computeAddress}.
*/
function computeAddress(bytes32 salt, bytes32 bytecodeHash, address deployer) internal pure returns (address addr) {
assembly ("memory-safe") {
let ptr := mload(0x40) // Get free memory pointer
// | | ↓ ptr ... ↓ ptr + 0x0B (start) ... ↓ ptr + 0x20 ... ↓ ptr + 0x40 ... |
// |---------------------|---------------------------------------------------------------------------|
// | bytecodeHash | CCCCCCCCCCCCC...CC |
// | salt | BBBBBBBBBBBBB...BB |
// | deployer | 000000...0000AAAAAAAAAAAAAAAAAAA...AA |
// | 0xFF | FF |
// |---------------------|---------------------------------------------------------------------------|
// | memory | 000000...00FFAAAAAAAAAAAAAAAAAAA...AABBBBBBBBBBBBB...BBCCCCCCCCCCCCC...CC |
// | keccak(start, 0x55) | ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑ |
mstore(add(ptr, 0x40), bytecodeHash)
mstore(add(ptr, 0x20), salt)
mstore(ptr, deployer) // Right-aligned with 12 preceding garbage bytes
let start := add(ptr, 0x0b) // The hashed data starts at the final garbage byte which we will set to 0xff
mstore8(start, 0xff)
addr := and(keccak256(start, 0x55), 0xffffffffffffffffffffffffffffffffffffffff)
}
}
}
contracts/lib/openzeppelin-contracts/contracts/token/ERC20/extensions/ERC20Burnable.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/ERC20Burnable.sol)
pragma solidity ^0.8.20;
import {ERC20} from "../ERC20.sol";
import {Context} from "../../../utils/Context.sol";
/**
* @dev Extension of {ERC20} that allows token holders to destroy both their own
* tokens and those that they have an allowance for, in a way that can be
* recognized off-chain (via event analysis).
*/
abstract contract ERC20Burnable is Context, ERC20 {
/**
* @dev Destroys a `value` amount of tokens from the caller.
*
* See {ERC20-_burn}.
*/
function burn(uint256 value) public virtual {
_burn(_msgSender(), value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, deducting from
* the caller's allowance.
*
* See {ERC20-_burn} and {ERC20-allowance}.
*
* Requirements:
*
* - the caller must have allowance for ``accounts``'s tokens of at least
* `value`.
*/
function burnFrom(address account, uint256 value) public virtual {
_spendAllowance(account, _msgSender(), value);
_burn(account, value);
}
}
contracts/lib/v4-periphery/src/interfaces/INotifier.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {ISubscriber} from "./ISubscriber.sol";
/// @title INotifier
/// @notice Interface for the Notifier contract
interface INotifier {
/// @notice Thrown when unsubscribing without a subscriber
error NotSubscribed();
/// @notice Thrown when a subscriber does not have code
error NoCodeSubscriber();
/// @notice Thrown when a user specifies a gas limit too low to avoid valid unsubscribe notifications
error GasLimitTooLow();
/// @notice Wraps the revert message of the subscriber contract on a reverting subscription
error SubscriptionReverted(address subscriber, bytes reason);
/// @notice Wraps the revert message of the subscriber contract on a reverting modify liquidity notification
error ModifyLiquidityNotificationReverted(address subscriber, bytes reason);
/// @notice Wraps the revert message of the subscriber contract on a reverting burn notification
error BurnNotificationReverted(address subscriber, bytes reason);
/// @notice Thrown when a tokenId already has a subscriber
error AlreadySubscribed(uint256 tokenId, address subscriber);
/// @notice Emitted on a successful call to subscribe
event Subscription(uint256 indexed tokenId, address indexed subscriber);
/// @notice Emitted on a successful call to unsubscribe
event Unsubscription(uint256 indexed tokenId, address indexed subscriber);
/// @notice Returns the subscriber for a respective position
/// @param tokenId the ERC721 tokenId
/// @return subscriber the subscriber contract
function subscriber(uint256 tokenId) external view returns (ISubscriber subscriber);
/// @notice Enables the subscriber to receive notifications for a respective position
/// @param tokenId the ERC721 tokenId
/// @param newSubscriber the address of the subscriber contract
/// @param data caller-provided data that's forwarded to the subscriber contract
/// @dev Calling subscribe when a position is already subscribed will revert
/// @dev payable so it can be multicalled with NATIVE related actions
/// @dev will revert if pool manager is locked
function subscribe(uint256 tokenId, address newSubscriber, bytes calldata data) external payable;
/// @notice Removes the subscriber from receiving notifications for a respective position
/// @param tokenId the ERC721 tokenId
/// @dev Callers must specify a high gas limit (remaining gas should be higher than unsubscriberGasLimit) such that the subscriber can be notified
/// @dev payable so it can be multicalled with NATIVE related actions
/// @dev Must always allow a user to unsubscribe. In the case of a malicious subscriber, a user can always unsubscribe safely, ensuring liquidity is always modifiable.
/// @dev will revert if pool manager is locked
function unsubscribe(uint256 tokenId) external payable;
/// @notice Returns and determines the maximum allowable gas-used for notifying unsubscribe
/// @return uint256 the maximum gas limit when notifying a subscriber's `notifyUnsubscribe` function
function unsubscribeGasLimit() external view returns (uint256);
}
contracts/lib/openzeppelin-contracts/contracts/utils/math/Math.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.6.0) (utils/math/Math.sol)
pragma solidity ^0.8.20;
import {Panic} from "../Panic.sol";
import {SafeCast} from "./SafeCast.sol";
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
enum Rounding {
Floor, // Toward negative infinity
Ceil, // Toward positive infinity
Trunc, // Toward zero
Expand // Away from zero
}
/**
* @dev Return the 512-bit addition of two uint256.
*
* The result is stored in two 256 variables such that sum = high * 2²⁵⁶ + low.
*/
function add512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
assembly ("memory-safe") {
low := add(a, b)
high := lt(low, a)
}
}
/**
* @dev Return the 512-bit multiplication of two uint256.
*
* The result is stored in two 256 variables such that product = high * 2²⁵⁶ + low.
*/
function mul512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
// 512-bit multiply [high low] = x * y. Compute the product mod 2²⁵⁶ and mod 2²⁵⁶ - 1, then use
// the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = high * 2²⁵⁶ + low.
assembly ("memory-safe") {
let mm := mulmod(a, b, not(0))
low := mul(a, b)
high := sub(sub(mm, low), lt(mm, low))
}
}
/**
* @dev Returns the addition of two unsigned integers, with a success flag (no overflow).
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a + b;
success = c >= a;
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with a success flag (no overflow).
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a - b;
success = c <= a;
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with a success flag (no overflow).
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a * b;
assembly ("memory-safe") {
// Only true when the multiplication doesn't overflow
// (c / a == b) || (a == 0)
success := or(eq(div(c, a), b), iszero(a))
}
// equivalent to: success ? c : 0
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the division of two unsigned integers, with a success flag (no division by zero).
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
success = b > 0;
assembly ("memory-safe") {
// The `DIV` opcode returns zero when the denominator is 0.
result := div(a, b)
}
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a success flag (no division by zero).
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
success = b > 0;
assembly ("memory-safe") {
// The `MOD` opcode returns zero when the denominator is 0.
result := mod(a, b)
}
}
}
/**
* @dev Unsigned saturating addition, bounds to `2²⁵⁶ - 1` instead of overflowing.
*/
function saturatingAdd(uint256 a, uint256 b) internal pure returns (uint256) {
(bool success, uint256 result) = tryAdd(a, b);
return ternary(success, result, type(uint256).max);
}
/**
* @dev Unsigned saturating subtraction, bounds to zero instead of overflowing.
*/
function saturatingSub(uint256 a, uint256 b) internal pure returns (uint256) {
(, uint256 result) = trySub(a, b);
return result;
}
/**
* @dev Unsigned saturating multiplication, bounds to `2²⁵⁶ - 1` instead of overflowing.
*/
function saturatingMul(uint256 a, uint256 b) internal pure returns (uint256) {
(bool success, uint256 result) = tryMul(a, b);
return ternary(success, result, type(uint256).max);
}
/**
* @dev Branchless ternary evaluation for `condition ? a : b`. Gas costs are constant.
*
* IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
* However, the compiler may optimize Solidity ternary operations (i.e. `condition ? a : b`) to only compute
* one branch when needed, making this function more expensive.
*/
function ternary(bool condition, uint256 a, uint256 b) internal pure returns (uint256) {
unchecked {
// branchless ternary works because:
// b ^ (a ^ b) == a
// b ^ 0 == b
return b ^ ((a ^ b) * SafeCast.toUint(condition));
}
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a > b, a, b);
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a < b, a, b);
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
unchecked {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds towards infinity instead
* of rounding towards zero.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
if (b == 0) {
// Guarantee the same behavior as in a regular Solidity division.
Panic.panic(Panic.DIVISION_BY_ZERO);
}
// The following calculation ensures accurate ceiling division without overflow.
// Since a is non-zero, (a - 1) / b will not overflow.
// The largest possible result occurs when (a - 1) / b is type(uint256).max,
// but the largest value we can obtain is type(uint256).max - 1, which happens
// when a = type(uint256).max and b = 1.
unchecked {
return SafeCast.toUint(a > 0) * ((a - 1) / b + 1);
}
}
/**
* @dev Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
* denominator == 0.
*
* Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) with further edits by
* Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
(uint256 high, uint256 low) = mul512(x, y);
// Handle non-overflow cases, 256 by 256 division.
if (high == 0) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return low / denominator;
}
// Make sure the result is less than 2²⁵⁶. Also prevents denominator == 0.
if (denominator <= high) {
Panic.panic(ternary(denominator == 0, Panic.DIVISION_BY_ZERO, Panic.UNDER_OVERFLOW));
}
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [high low].
uint256 remainder;
assembly ("memory-safe") {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
high := sub(high, gt(remainder, low))
low := sub(low, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator.
// Always >= 1. See https://cs.stackexchange.com/q/138556/92363.
uint256 twos = denominator & (0 - denominator);
assembly ("memory-safe") {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [high low] by twos.
low := div(low, twos)
// Flip twos such that it is 2²⁵⁶ / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from high into low.
low |= high * twos;
// Invert denominator mod 2²⁵⁶. Now that denominator is an odd number, it has an inverse modulo 2²⁵⁶ such
// that denominator * inv ≡ 1 mod 2²⁵⁶. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv ≡ 1 mod 2⁴.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also
// works in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2⁸
inverse *= 2 - denominator * inverse; // inverse mod 2¹⁶
inverse *= 2 - denominator * inverse; // inverse mod 2³²
inverse *= 2 - denominator * inverse; // inverse mod 2⁶⁴
inverse *= 2 - denominator * inverse; // inverse mod 2¹²⁸
inverse *= 2 - denominator * inverse; // inverse mod 2²⁵⁶
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2²⁵⁶. Since the preconditions guarantee that the outcome is
// less than 2²⁵⁶, this is the final result. We don't need to compute the high bits of the result and high
// is no longer required.
result = low * inverse;
return result;
}
}
/**
* @dev Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
return mulDiv(x, y, denominator) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0);
}
/**
* @dev Calculates floor(x * y >> n) with full precision. Throws if result overflows a uint256.
*/
function mulShr(uint256 x, uint256 y, uint8 n) internal pure returns (uint256 result) {
unchecked {
(uint256 high, uint256 low) = mul512(x, y);
if (high >= 1 << n) {
Panic.panic(Panic.UNDER_OVERFLOW);
}
return (high << (256 - n)) | (low >> n);
}
}
/**
* @dev Calculates x * y >> n with full precision, following the selected rounding direction.
*/
function mulShr(uint256 x, uint256 y, uint8 n, Rounding rounding) internal pure returns (uint256) {
return mulShr(x, y, n) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, 1 << n) > 0);
}
/**
* @dev Calculate the modular multiplicative inverse of a number in Z/nZ.
*
* If n is a prime, then Z/nZ is a field. In that case all elements are inversible, except 0.
* If n is not a prime, then Z/nZ is not a field, and some elements might not be inversible.
*
* If the input value is not inversible, 0 is returned.
*
* NOTE: If you know for sure that n is (big) a prime, it may be cheaper to use Fermat's little theorem and get the
* inverse using `Math.modExp(a, n - 2, n)`. See {invModPrime}.
*/
function invMod(uint256 a, uint256 n) internal pure returns (uint256) {
unchecked {
if (n == 0) return 0;
// The inverse modulo is calculated using the Extended Euclidean Algorithm (iterative version)
// Used to compute integers x and y such that: ax + ny = gcd(a, n).
// When the gcd is 1, then the inverse of a modulo n exists and it's x.
// ax + ny = 1
// ax = 1 + (-y)n
// ax ≡ 1 (mod n) # x is the inverse of a modulo n
// If the remainder is 0 the gcd is n right away.
uint256 remainder = a % n;
uint256 gcd = n;
// Therefore the initial coefficients are:
// ax + ny = gcd(a, n) = n
// 0a + 1n = n
int256 x = 0;
int256 y = 1;
while (remainder != 0) {
uint256 quotient = gcd / remainder;
(gcd, remainder) = (
// The old remainder is the next gcd to try.
remainder,
// Compute the next remainder.
// Can't overflow given that (a % gcd) * (gcd // (a % gcd)) <= gcd
// where gcd is at most n (capped to type(uint256).max)
gcd - remainder * quotient
);
(x, y) = (
// Increment the coefficient of a.
y,
// Decrement the coefficient of n.
// Can overflow, but the result is casted to uint256 so that the
// next value of y is "wrapped around" to a value between 0 and n - 1.
x - y * int256(quotient)
);
}
if (gcd != 1) return 0; // No inverse exists.
return ternary(x < 0, n - uint256(-x), uint256(x)); // Wrap the result if it's negative.
}
}
/**
* @dev Variant of {invMod}. More efficient, but only works if `p` is known to be a prime greater than `2`.
*
* From https://en.wikipedia.org/wiki/Fermat%27s_little_theorem[Fermat's little theorem], we know that if p is
* prime, then `a**(p-1) ≡ 1 mod p`. As a consequence, we have `a * a**(p-2) ≡ 1 mod p`, which means that
* `a**(p-2)` is the modular multiplicative inverse of a in Fp.
*
* NOTE: this function does NOT check that `p` is a prime greater than `2`.
*/
function invModPrime(uint256 a, uint256 p) internal view returns (uint256) {
unchecked {
return Math.modExp(a, p - 2, p);
}
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m)
*
* Requirements:
* - modulus can't be zero
* - underlying staticcall to precompile must succeed
*
* IMPORTANT: The result is only valid if the underlying call succeeds. When using this function, make
* sure the chain you're using it on supports the precompiled contract for modular exponentiation
* at address 0x05 as specified in https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise,
* the underlying function will succeed given the lack of a revert, but the result may be incorrectly
* interpreted as 0.
*/
function modExp(uint256 b, uint256 e, uint256 m) internal view returns (uint256) {
(bool success, uint256 result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m).
* It includes a success flag indicating if the operation succeeded. Operation will be marked as failed if trying
* to operate modulo 0 or if the underlying precompile reverted.
*
* IMPORTANT: The result is only valid if the success flag is true. When using this function, make sure the chain
* you're using it on supports the precompiled contract for modular exponentiation at address 0x05 as specified in
* https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise, the underlying function will succeed given the lack
* of a revert, but the result may be incorrectly interpreted as 0.
*/
function tryModExp(uint256 b, uint256 e, uint256 m) internal view returns (bool success, uint256 result) {
if (m == 0) return (false, 0);
assembly ("memory-safe") {
let ptr := mload(0x40)
// | Offset | Content | Content (Hex) |
// |-----------|------------|--------------------------------------------------------------------|
// | 0x00:0x1f | size of b | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x20:0x3f | size of e | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x40:0x5f | size of m | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x60:0x7f | value of b | 0x<.............................................................b> |
// | 0x80:0x9f | value of e | 0x<.............................................................e> |
// | 0xa0:0xbf | value of m | 0x<.............................................................m> |
mstore(ptr, 0x20)
mstore(add(ptr, 0x20), 0x20)
mstore(add(ptr, 0x40), 0x20)
mstore(add(ptr, 0x60), b)
mstore(add(ptr, 0x80), e)
mstore(add(ptr, 0xa0), m)
// Given the result < m, it's guaranteed to fit in 32 bytes,
// so we can use the memory scratch space located at offset 0.
success := staticcall(gas(), 0x05, ptr, 0xc0, 0x00, 0x20)
result := mload(0x00)
}
}
/**
* @dev Variant of {modExp} that supports inputs of arbitrary length.
*/
function modExp(bytes memory b, bytes memory e, bytes memory m) internal view returns (bytes memory) {
(bool success, bytes memory result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Variant of {tryModExp} that supports inputs of arbitrary length.
*/
function tryModExp(
bytes memory b,
bytes memory e,
bytes memory m
) internal view returns (bool success, bytes memory result) {
if (_zeroBytes(m)) return (false, new bytes(0));
uint256 mLen = m.length;
// Encode call args in result and move the free memory pointer
result = abi.encodePacked(b.length, e.length, mLen, b, e, m);
assembly ("memory-safe") {
let dataPtr := add(result, 0x20)
// Write result on top of args to avoid allocating extra memory.
success := staticcall(gas(), 0x05, dataPtr, mload(result), dataPtr, mLen)
// Overwrite the length.
// result.length > returndatasize() is guaranteed because returndatasize() == m.length
mstore(result, mLen)
// Set the memory pointer after the returned data.
mstore(0x40, add(dataPtr, mLen))
}
}
/**
* @dev Returns whether the provided byte array is zero.
*/
function _zeroBytes(bytes memory buffer) private pure returns (bool) {
uint256 chunk;
for (uint256 i = 0; i < buffer.length; i += 0x20) {
// See _unsafeReadBytesOffset from utils/Bytes.sol
assembly ("memory-safe") {
chunk := mload(add(add(buffer, 0x20), i))
}
if (chunk >> (8 * saturatingSub(i + 0x20, buffer.length)) != 0) {
return false;
}
}
return true;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
* towards zero.
*
* This method is based on Newton's method for computing square roots; the algorithm is restricted to only
* using integer operations.
*/
function sqrt(uint256 a) internal pure returns (uint256) {
unchecked {
// Take care of easy edge cases when a == 0 or a == 1
if (a <= 1) {
return a;
}
// In this function, we use Newton's method to get a root of `f(x) := x² - a`. It involves building a
// sequence x_n that converges toward sqrt(a). For each iteration x_n, we also define the error between
// the current value as `ε_n = | x_n - sqrt(a) |`.
//
// For our first estimation, we consider `e` the smallest power of 2 which is bigger than the square root
// of the target. (i.e. `2**(e-1) ≤ sqrt(a) < 2**e`). We know that `e ≤ 128` because `(2¹²⁸)² = 2²⁵⁶` is
// bigger than any uint256.
//
// By noticing that
// `2**(e-1) ≤ sqrt(a) < 2**e → (2**(e-1))² ≤ a < (2**e)² → 2**(2*e-2) ≤ a < 2**(2*e)`
// we can deduce that `e - 1` is `log2(a) / 2`. We can thus compute `x_n = 2**(e-1)` using a method similar
// to the msb function.
uint256 aa = a;
uint256 xn = 1;
if (aa >= (1 << 128)) {
aa >>= 128;
xn <<= 64;
}
if (aa >= (1 << 64)) {
aa >>= 64;
xn <<= 32;
}
if (aa >= (1 << 32)) {
aa >>= 32;
xn <<= 16;
}
if (aa >= (1 << 16)) {
aa >>= 16;
xn <<= 8;
}
if (aa >= (1 << 8)) {
aa >>= 8;
xn <<= 4;
}
if (aa >= (1 << 4)) {
aa >>= 4;
xn <<= 2;
}
if (aa >= (1 << 2)) {
xn <<= 1;
}
// We now have x_n such that `x_n = 2**(e-1) ≤ sqrt(a) < 2**e = 2 * x_n`. This implies ε_n ≤ 2**(e-1).
//
// We can refine our estimation by noticing that the middle of that interval minimizes the error.
// If we move x_n to equal 2**(e-1) + 2**(e-2), then we reduce the error to ε_n ≤ 2**(e-2).
// This is going to be our x_0 (and ε_0)
xn = (3 * xn) >> 1; // ε_0 := | x_0 - sqrt(a) | ≤ 2**(e-2)
// From here, Newton's method give us:
// x_{n+1} = (x_n + a / x_n) / 2
//
// One should note that:
// x_{n+1}² - a = ((x_n + a / x_n) / 2)² - a
// = ((x_n² + a) / (2 * x_n))² - a
// = (x_n⁴ + 2 * a * x_n² + a²) / (4 * x_n²) - a
// = (x_n⁴ + 2 * a * x_n² + a² - 4 * a * x_n²) / (4 * x_n²)
// = (x_n⁴ - 2 * a * x_n² + a²) / (4 * x_n²)
// = (x_n² - a)² / (2 * x_n)²
// = ((x_n² - a) / (2 * x_n))²
// ≥ 0
// Which proves that for all n ≥ 1, sqrt(a) ≤ x_n
//
// This gives us the proof of quadratic convergence of the sequence:
// ε_{n+1} = | x_{n+1} - sqrt(a) |
// = | (x_n + a / x_n) / 2 - sqrt(a) |
// = | (x_n² + a - 2*x_n*sqrt(a)) / (2 * x_n) |
// = | (x_n - sqrt(a))² / (2 * x_n) |
// = | ε_n² / (2 * x_n) |
// = ε_n² / | (2 * x_n) |
//
// For the first iteration, we have a special case where x_0 is known:
// ε_1 = ε_0² / | (2 * x_0) |
// ≤ (2**(e-2))² / (2 * (2**(e-1) + 2**(e-2)))
// ≤ 2**(2*e-4) / (3 * 2**(e-1))
// ≤ 2**(e-3) / 3
// ≤ 2**(e-3-log2(3))
// ≤ 2**(e-4.5)
//
// For the following iterations, we use the fact that, 2**(e-1) ≤ sqrt(a) ≤ x_n:
// ε_{n+1} = ε_n² / | (2 * x_n) |
// ≤ (2**(e-k))² / (2 * 2**(e-1))
// ≤ 2**(2*e-2*k) / 2**e
// ≤ 2**(e-2*k)
xn = (xn + a / xn) >> 1; // ε_1 := | x_1 - sqrt(a) | ≤ 2**(e-4.5) -- special case, see above
xn = (xn + a / xn) >> 1; // ε_2 := | x_2 - sqrt(a) | ≤ 2**(e-9) -- general case with k = 4.5
xn = (xn + a / xn) >> 1; // ε_3 := | x_3 - sqrt(a) | ≤ 2**(e-18) -- general case with k = 9
xn = (xn + a / xn) >> 1; // ε_4 := | x_4 - sqrt(a) | ≤ 2**(e-36) -- general case with k = 18
xn = (xn + a / xn) >> 1; // ε_5 := | x_5 - sqrt(a) | ≤ 2**(e-72) -- general case with k = 36
xn = (xn + a / xn) >> 1; // ε_6 := | x_6 - sqrt(a) | ≤ 2**(e-144) -- general case with k = 72
// Because e ≤ 128 (as discussed during the first estimation phase), we know have reached a precision
// ε_6 ≤ 2**(e-144) < 1. Given we're operating on integers, then we can ensure that xn is now either
// sqrt(a) or sqrt(a) + 1.
return xn - SafeCast.toUint(xn > a / xn);
}
}
/**
* @dev Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && result * result < a);
}
}
/**
* @dev Return the log in base 2 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log2(uint256 x) internal pure returns (uint256 r) {
// If value has upper 128 bits set, log2 result is at least 128
r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
// If upper 64 bits of 128-bit half set, add 64 to result
r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
// If upper 32 bits of 64-bit half set, add 32 to result
r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
// If upper 16 bits of 32-bit half set, add 16 to result
r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
// If upper 8 bits of 16-bit half set, add 8 to result
r |= SafeCast.toUint((x >> r) > 0xff) << 3;
// If upper 4 bits of 8-bit half set, add 4 to result
r |= SafeCast.toUint((x >> r) > 0xf) << 2;
// Shifts value right by the current result and use it as an index into this lookup table:
//
// | x (4 bits) | index | table[index] = MSB position |
// |------------|---------|-----------------------------|
// | 0000 | 0 | table[0] = 0 |
// | 0001 | 1 | table[1] = 0 |
// | 0010 | 2 | table[2] = 1 |
// | 0011 | 3 | table[3] = 1 |
// | 0100 | 4 | table[4] = 2 |
// | 0101 | 5 | table[5] = 2 |
// | 0110 | 6 | table[6] = 2 |
// | 0111 | 7 | table[7] = 2 |
// | 1000 | 8 | table[8] = 3 |
// | 1001 | 9 | table[9] = 3 |
// | 1010 | 10 | table[10] = 3 |
// | 1011 | 11 | table[11] = 3 |
// | 1100 | 12 | table[12] = 3 |
// | 1101 | 13 | table[13] = 3 |
// | 1110 | 14 | table[14] = 3 |
// | 1111 | 15 | table[15] = 3 |
//
// The lookup table is represented as a 32-byte value with the MSB positions for 0-15 in the first 16 bytes (most significant half).
assembly ("memory-safe") {
r := or(r, byte(shr(r, x), 0x0000010102020202030303030303030300000000000000000000000000000000))
}
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << result < value);
}
}
/**
* @dev Return the log in base 10 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 10 ** result < value);
}
}
/**
* @dev Return the log in base 256 of a positive value rounded towards zero.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 x) internal pure returns (uint256 r) {
// If value has upper 128 bits set, log2 result is at least 128
r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
// If upper 64 bits of 128-bit half set, add 64 to result
r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
// If upper 32 bits of 64-bit half set, add 32 to result
r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
// If upper 16 bits of 32-bit half set, add 16 to result
r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
// Add 1 if upper 8 bits of 16-bit half set, and divide accumulated result by 8
return (r >> 3) | SafeCast.toUint((x >> r) > 0xff);
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << (result << 3) < value);
}
}
/**
* @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
*/
function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
return uint8(rounding) % 2 == 1;
}
/**
* @dev Counts the number of leading zero bits in a uint256.
*/
function clz(uint256 x) internal pure returns (uint256) {
return ternary(x == 0, 256, 255 - log2(x));
}
}
contracts/lib/openzeppelin-contracts/contracts/utils/Panic.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Panic.sol)
pragma solidity ^0.8.20;
/**
* @dev Helper library for emitting standardized panic codes.
*
* ```solidity
* contract Example {
* using Panic for uint256;
*
* // Use any of the declared internal constants
* function foo() { Panic.GENERIC.panic(); }
*
* // Alternatively
* function foo() { Panic.panic(Panic.GENERIC); }
* }
* ```
*
* Follows the list from https://github.com/ethereum/solidity/blob/v0.8.24/libsolutil/ErrorCodes.h[libsolutil].
*
* _Available since v5.1._
*/
// slither-disable-next-line unused-state
library Panic {
/// @dev generic / unspecified error
uint256 internal constant GENERIC = 0x00;
/// @dev used by the assert() builtin
uint256 internal constant ASSERT = 0x01;
/// @dev arithmetic underflow or overflow
uint256 internal constant UNDER_OVERFLOW = 0x11;
/// @dev division or modulo by zero
uint256 internal constant DIVISION_BY_ZERO = 0x12;
/// @dev enum conversion error
uint256 internal constant ENUM_CONVERSION_ERROR = 0x21;
/// @dev invalid encoding in storage
uint256 internal constant STORAGE_ENCODING_ERROR = 0x22;
/// @dev empty array pop
uint256 internal constant EMPTY_ARRAY_POP = 0x31;
/// @dev array out of bounds access
uint256 internal constant ARRAY_OUT_OF_BOUNDS = 0x32;
/// @dev resource error (too large allocation or too large array)
uint256 internal constant RESOURCE_ERROR = 0x41;
/// @dev calling invalid internal function
uint256 internal constant INVALID_INTERNAL_FUNCTION = 0x51;
/// @dev Reverts with a panic code. Recommended to use with
/// the internal constants with predefined codes.
function panic(uint256 code) internal pure {
assembly ("memory-safe") {
mstore(0x00, 0x4e487b71)
mstore(0x20, code)
revert(0x1c, 0x24)
}
}
}
contracts/lib/v4-periphery/src/interfaces/IPermit2Forwarder.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {IAllowanceTransfer} from "permit2/src/interfaces/IAllowanceTransfer.sol";
/// @title IPermit2Forwarder
/// @notice Interface for the Permit2Forwarder contract
interface IPermit2Forwarder {
/// @notice allows forwarding a single permit to permit2
/// @dev this function is payable to allow multicall with NATIVE based actions
/// @param owner the owner of the tokens
/// @param permitSingle the permit data
/// @param signature the signature of the permit; abi.encodePacked(r, s, v)
/// @return err the error returned by a reverting permit call, empty if successful
function permit(address owner, IAllowanceTransfer.PermitSingle calldata permitSingle, bytes calldata signature)
external
payable
returns (bytes memory err);
/// @notice allows forwarding batch permits to permit2
/// @dev this function is payable to allow multicall with NATIVE based actions
/// @param owner the owner of the tokens
/// @param _permitBatch a batch of approvals
/// @param signature the signature of the permit; abi.encodePacked(r, s, v)
/// @return err the error returned by a reverting permit call, empty if successful
function permitBatch(address owner, IAllowanceTransfer.PermitBatch calldata _permitBatch, bytes calldata signature)
external
payable
returns (bytes memory err);
}
contracts/lib/openzeppelin-contracts/contracts/utils/StorageSlot.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
pragma solidity ^0.8.20;
/**
* @dev Library for reading and writing primitive types to specific storage slots.
*
* Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
* This library helps with reading and writing to such slots without the need for inline assembly.
*
* The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
*
* Example usage to set ERC-1967 implementation slot:
* ```solidity
* contract ERC1967 {
* // Define the slot. Alternatively, use the SlotDerivation library to derive the slot.
* bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
*
* function _getImplementation() internal view returns (address) {
* return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
* }
*
* function _setImplementation(address newImplementation) internal {
* require(newImplementation.code.length > 0);
* StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
* }
* }
* ```
*
* TIP: Consider using this library along with {SlotDerivation}.
*/
library StorageSlot {
struct AddressSlot {
address value;
}
struct BooleanSlot {
bool value;
}
struct Bytes32Slot {
bytes32 value;
}
struct Uint256Slot {
uint256 value;
}
struct Int256Slot {
int256 value;
}
struct StringSlot {
string value;
}
struct BytesSlot {
bytes value;
}
/**
* @dev Returns an `AddressSlot` with member `value` located at `slot`.
*/
function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `BooleanSlot` with member `value` located at `slot`.
*/
function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Bytes32Slot` with member `value` located at `slot`.
*/
function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Uint256Slot` with member `value` located at `slot`.
*/
function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Int256Slot` with member `value` located at `slot`.
*/
function getInt256Slot(bytes32 slot) internal pure returns (Int256Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `StringSlot` with member `value` located at `slot`.
*/
function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` representation of the string storage pointer `store`.
*/
function getStringSlot(string storage store) internal pure returns (StringSlot storage r) {
assembly ("memory-safe") {
r.slot := store.slot
}
}
/**
* @dev Returns a `BytesSlot` with member `value` located at `slot`.
*/
function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns an `BytesSlot` representation of the bytes storage pointer `store`.
*/
function getBytesSlot(bytes storage store) internal pure returns (BytesSlot storage r) {
assembly ("memory-safe") {
r.slot := store.slot
}
}
}
contracts/lib/v4-periphery/src/interfaces/ISubscriber.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {BalanceDelta} from "@uniswap/v4-core/src/types/BalanceDelta.sol";
import {PositionInfo} from "../libraries/PositionInfoLibrary.sol";
/// @title ISubscriber
/// @notice Interface that a Subscriber contract should implement to receive updates from the v4 position manager
interface ISubscriber {
/// @notice Called when a position subscribes to this subscriber contract
/// @param tokenId the token ID of the position
/// @param data additional data passed in by the caller
function notifySubscribe(uint256 tokenId, bytes memory data) external;
/// @notice Called when a position unsubscribes from the subscriber
/// @dev This call's gas is capped at `unsubscribeGasLimit` (set at deployment)
/// @dev Because of EIP-150, solidity may only allocate 63/64 of gasleft()
/// @param tokenId the token ID of the position
function notifyUnsubscribe(uint256 tokenId) external;
/// @notice Called when a position is burned
/// @param tokenId the token ID of the position
/// @param owner the current owner of the tokenId
/// @param info information about the position
/// @param liquidity the amount of liquidity decreased in the position, may be 0
/// @param feesAccrued the fees accrued by the position if liquidity was decreased
function notifyBurn(uint256 tokenId, address owner, PositionInfo info, uint256 liquidity, BalanceDelta feesAccrued)
external;
/// @notice Called when a position modifies its liquidity or collects fees
/// @param tokenId the token ID of the position
/// @param liquidityChange the change in liquidity on the underlying position
/// @param feesAccrued the fees to be collected from the position as a result of the modifyLiquidity call
/// @dev Note that feesAccrued can be artificially inflated by a malicious user
/// Pools with a single liquidity position can inflate feeGrowthGlobal (and consequently feesAccrued) by donating to themselves;
/// atomically donating and collecting fees within the same unlockCallback may further inflate feeGrowthGlobal/feesAccrued
function notifyModifyLiquidity(uint256 tokenId, int256 liquidityChange, BalanceDelta feesAccrued) external;
}
contracts/lib/v4-core/src/types/PoolOperation.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
import {PoolKey} from "../types/PoolKey.sol";
import {BalanceDelta} from "../types/BalanceDelta.sol";
/// @notice Parameter struct for `ModifyLiquidity` pool operations
struct ModifyLiquidityParams {
// the lower and upper tick of the position
int24 tickLower;
int24 tickUpper;
// how to modify the liquidity
int256 liquidityDelta;
// a value to set if you want unique liquidity positions at the same range
bytes32 salt;
}
/// @notice Parameter struct for `Swap` pool operations
struct SwapParams {
/// Whether to swap token0 for token1 or vice versa
bool zeroForOne;
/// The desired input amount if negative (exactIn), or the desired output amount if positive (exactOut)
int256 amountSpecified;
/// The sqrt price at which, if reached, the swap will stop executing
uint160 sqrtPriceLimitX96;
}
contracts/lib/openzeppelin-contracts/contracts/utils/Errors.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Errors.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of common custom errors used in multiple contracts
*
* IMPORTANT: Backwards compatibility is not guaranteed in future versions of the library.
* It is recommended to avoid relying on the error API for critical functionality.
*
* _Available since v5.1._
*/
library Errors {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error InsufficientBalance(uint256 balance, uint256 needed);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedCall();
/**
* @dev The deployment failed.
*/
error FailedDeployment();
/**
* @dev A necessary precompile is missing.
*/
error MissingPrecompile(address);
}
contracts/lib/v4-core/src/types/Currency.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {IERC20Minimal} from "../interfaces/external/IERC20Minimal.sol";
import {CustomRevert} from "../libraries/CustomRevert.sol";
type Currency is address;
using {greaterThan as >, lessThan as <, greaterThanOrEqualTo as >=, equals as ==} for Currency global;
using CurrencyLibrary for Currency global;
function equals(Currency currency, Currency other) pure returns (bool) {
return Currency.unwrap(currency) == Currency.unwrap(other);
}
function greaterThan(Currency currency, Currency other) pure returns (bool) {
return Currency.unwrap(currency) > Currency.unwrap(other);
}
function lessThan(Currency currency, Currency other) pure returns (bool) {
return Currency.unwrap(currency) < Currency.unwrap(other);
}
function greaterThanOrEqualTo(Currency currency, Currency other) pure returns (bool) {
return Currency.unwrap(currency) >= Currency.unwrap(other);
}
/// @title CurrencyLibrary
/// @dev This library allows for transferring and holding native tokens and ERC20 tokens
library CurrencyLibrary {
/// @notice Additional context for ERC-7751 wrapped error when a native transfer fails
error NativeTransferFailed();
/// @notice Additional context for ERC-7751 wrapped error when an ERC20 transfer fails
error ERC20TransferFailed();
/// @notice A constant to represent the native currency
Currency public constant ADDRESS_ZERO = Currency.wrap(address(0));
function transfer(Currency currency, address to, uint256 amount) internal {
// altered from https://github.com/transmissions11/solmate/blob/44a9963d4c78111f77caa0e65d677b8b46d6f2e6/src/utils/SafeTransferLib.sol
// modified custom error selectors
bool success;
if (currency.isAddressZero()) {
assembly ("memory-safe") {
// Transfer the ETH and revert if it fails.
success := call(gas(), to, amount, 0, 0, 0, 0)
}
// revert with NativeTransferFailed, containing the bubbled up error as an argument
if (!success) {
CustomRevert.bubbleUpAndRevertWith(to, bytes4(0), NativeTransferFailed.selector);
}
} else {
assembly ("memory-safe") {
// Get a pointer to some free memory.
let fmp := mload(0x40)
// Write the abi-encoded calldata into memory, beginning with the function selector.
mstore(fmp, 0xa9059cbb00000000000000000000000000000000000000000000000000000000)
mstore(add(fmp, 4), and(to, 0xffffffffffffffffffffffffffffffffffffffff)) // Append and mask the "to" argument.
mstore(add(fmp, 36), amount) // Append the "amount" argument. Masking not required as it's a full 32 byte type.
success :=
and(
// Set success to whether the call reverted, if not we check it either
// returned exactly 1 (can't just be non-zero data), or had no return data.
or(and(eq(mload(0), 1), gt(returndatasize(), 31)), iszero(returndatasize())),
// We use 68 because the length of our calldata totals up like so: 4 + 32 * 2.
// We use 0 and 32 to copy up to 32 bytes of return data into the scratch space.
// Counterintuitively, this call must be positioned second to the or() call in the
// surrounding and() call or else returndatasize() will be zero during the computation.
call(gas(), currency, 0, fmp, 68, 0, 32)
)
// Now clean the memory we used
mstore(fmp, 0) // 4 byte `selector` and 28 bytes of `to` were stored here
mstore(add(fmp, 0x20), 0) // 4 bytes of `to` and 28 bytes of `amount` were stored here
mstore(add(fmp, 0x40), 0) // 4 bytes of `amount` were stored here
}
// revert with ERC20TransferFailed, containing the bubbled up error as an argument
if (!success) {
CustomRevert.bubbleUpAndRevertWith(
Currency.unwrap(currency), IERC20Minimal.transfer.selector, ERC20TransferFailed.selector
);
}
}
}
function balanceOfSelf(Currency currency) internal view returns (uint256) {
if (currency.isAddressZero()) {
return address(this).balance;
} else {
return IERC20Minimal(Currency.unwrap(currency)).balanceOf(address(this));
}
}
function balanceOf(Currency currency, address owner) internal view returns (uint256) {
if (currency.isAddressZero()) {
return owner.balance;
} else {
return IERC20Minimal(Currency.unwrap(currency)).balanceOf(owner);
}
}
function isAddressZero(Currency currency) internal pure returns (bool) {
return Currency.unwrap(currency) == Currency.unwrap(ADDRESS_ZERO);
}
function toId(Currency currency) internal pure returns (uint256) {
return uint160(Currency.unwrap(currency));
}
// If the upper 12 bytes are non-zero, they will be zero-ed out
// Therefore, fromId() and toId() are not inverses of each other
function fromId(uint256 id) internal pure returns (Currency) {
return Currency.wrap(address(uint160(id)));
}
}
contracts/lib/v4-core/src/interfaces/IProtocolFees.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {Currency} from "../types/Currency.sol";
import {PoolId} from "../types/PoolId.sol";
import {PoolKey} from "../types/PoolKey.sol";
/// @notice Interface for all protocol-fee related functions in the pool manager
interface IProtocolFees {
/// @notice Thrown when protocol fee is set too high
error ProtocolFeeTooLarge(uint24 fee);
/// @notice Thrown when collectProtocolFees or setProtocolFee is not called by the controller.
error InvalidCaller();
/// @notice Thrown when collectProtocolFees is attempted on a token that is synced.
error ProtocolFeeCurrencySynced();
/// @notice Emitted when the protocol fee controller address is updated in setProtocolFeeController.
event ProtocolFeeControllerUpdated(address indexed protocolFeeController);
/// @notice Emitted when the protocol fee is updated for a pool.
event ProtocolFeeUpdated(PoolId indexed id, uint24 protocolFee);
/// @notice Given a currency address, returns the protocol fees accrued in that currency
/// @param currency The currency to check
/// @return amount The amount of protocol fees accrued in the currency
function protocolFeesAccrued(Currency currency) external view returns (uint256 amount);
/// @notice Sets the protocol fee for the given pool
/// @param key The key of the pool to set a protocol fee for
/// @param newProtocolFee The fee to set
function setProtocolFee(PoolKey memory key, uint24 newProtocolFee) external;
/// @notice Sets the protocol fee controller
/// @param controller The new protocol fee controller
function setProtocolFeeController(address controller) external;
/// @notice Collects the protocol fees for a given recipient and currency, returning the amount collected
/// @dev This will revert if the contract is unlocked
/// @param recipient The address to receive the protocol fees
/// @param currency The currency to withdraw
/// @param amount The amount of currency to withdraw
/// @return amountCollected The amount of currency successfully withdrawn
function collectProtocolFees(address recipient, Currency currency, uint256 amount)
external
returns (uint256 amountCollected);
/// @notice Returns the current protocol fee controller address
/// @return address The current protocol fee controller address
function protocolFeeController() external view returns (address);
}
contracts/lib/openzeppelin-contracts/contracts/token/ERC20/IERC20.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/IERC20.sol)
pragma solidity >=0.4.16;
/**
* @dev Interface of the ERC-20 standard as defined in the ERC.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 value) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 value) external returns (bool);
}
contracts/lib/v4-core/src/interfaces/IExtsload.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @notice Interface for functions to access any storage slot in a contract
interface IExtsload {
/// @notice Called by external contracts to access granular pool state
/// @param slot Key of slot to sload
/// @return value The value of the slot as bytes32
function extsload(bytes32 slot) external view returns (bytes32 value);
/// @notice Called by external contracts to access granular pool state
/// @param startSlot Key of slot to start sloading from
/// @param nSlots Number of slots to load into return value
/// @return values List of loaded values.
function extsload(bytes32 startSlot, uint256 nSlots) external view returns (bytes32[] memory values);
/// @notice Called by external contracts to access sparse pool state
/// @param slots List of slots to SLOAD from.
/// @return values List of loaded values.
function extsload(bytes32[] calldata slots) external view returns (bytes32[] memory values);
}
contracts/lib/openzeppelin-contracts/contracts/interfaces/draft-IERC6093.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (interfaces/draft-IERC6093.sol)
pragma solidity >=0.8.4;
/**
* @dev Standard ERC-20 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-20 tokens.
*/
interface IERC20Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC20InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC20InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
* @param spender Address that may be allowed to operate on tokens without being their owner.
* @param allowance Amount of tokens a `spender` is allowed to operate with.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC20InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `spender` to be approved. Used in approvals.
* @param spender Address that may be allowed to operate on tokens without being their owner.
*/
error ERC20InvalidSpender(address spender);
}
/**
* @dev Standard ERC-721 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-721 tokens.
*/
interface IERC721Errors {
/**
* @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in ERC-721.
* Used in balance queries.
* @param owner Address of the current owner of a token.
*/
error ERC721InvalidOwner(address owner);
/**
* @dev Indicates a `tokenId` whose `owner` is the zero address.
* @param tokenId Identifier number of a token.
*/
error ERC721NonexistentToken(uint256 tokenId);
/**
* @dev Indicates an error related to the ownership over a particular token. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param tokenId Identifier number of a token.
* @param owner Address of the current owner of a token.
*/
error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC721InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC721InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param tokenId Identifier number of a token.
*/
error ERC721InsufficientApproval(address operator, uint256 tokenId);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC721InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC721InvalidOperator(address operator);
}
/**
* @dev Standard ERC-1155 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-1155 tokens.
*/
interface IERC1155Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
* @param tokenId Identifier number of a token.
*/
error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC1155InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC1155InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param owner Address of the current owner of a token.
*/
error ERC1155MissingApprovalForAll(address operator, address owner);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC1155InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC1155InvalidOperator(address operator);
/**
* @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
* Used in batch transfers.
* @param idsLength Length of the array of token identifiers
* @param valuesLength Length of the array of token amounts
*/
error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}
contracts/lib/v4-core/src/types/PoolKey.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {Currency} from "./Currency.sol";
import {IHooks} from "../interfaces/IHooks.sol";
import {PoolIdLibrary} from "./PoolId.sol";
using PoolIdLibrary for PoolKey global;
/// @notice Returns the key for identifying a pool
struct PoolKey {
/// @notice The lower currency of the pool, sorted numerically
Currency currency0;
/// @notice The higher currency of the pool, sorted numerically
Currency currency1;
/// @notice The pool LP fee, capped at 1_000_000. If the highest bit is 1, the pool has a dynamic fee and must be exactly equal to 0x800000
uint24 fee;
/// @notice Ticks that involve positions must be a multiple of tick spacing
int24 tickSpacing;
/// @notice The hooks of the pool
IHooks hooks;
}
contracts/lib/v4-core/src/libraries/UnsafeMath.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title Math functions that do not check inputs or outputs
/// @notice Contains methods that perform common math functions but do not do any overflow or underflow checks
library UnsafeMath {
/// @notice Returns ceil(x / y)
/// @dev division by 0 will return 0, and should be checked externally
/// @param x The dividend
/// @param y The divisor
/// @return z The quotient, ceil(x / y)
function divRoundingUp(uint256 x, uint256 y) internal pure returns (uint256 z) {
assembly ("memory-safe") {
z := add(div(x, y), gt(mod(x, y), 0))
}
}
/// @notice Calculates floor(a×b÷denominator)
/// @dev division by 0 will return 0, and should be checked externally
/// @param a The multiplicand
/// @param b The multiplier
/// @param denominator The divisor
/// @return result The 256-bit result, floor(a×b÷denominator)
function simpleMulDiv(uint256 a, uint256 b, uint256 denominator) internal pure returns (uint256 result) {
assembly ("memory-safe") {
result := div(mul(a, b), denominator)
}
}
}
contracts/lib/v4-core/src/libraries/Hooks.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {PoolKey} from "../types/PoolKey.sol";
import {IHooks} from "../interfaces/IHooks.sol";
import {SafeCast} from "./SafeCast.sol";
import {LPFeeLibrary} from "./LPFeeLibrary.sol";
import {BalanceDelta, toBalanceDelta, BalanceDeltaLibrary} from "../types/BalanceDelta.sol";
import {BeforeSwapDelta, BeforeSwapDeltaLibrary} from "../types/BeforeSwapDelta.sol";
import {IPoolManager} from "../interfaces/IPoolManager.sol";
import {ModifyLiquidityParams, SwapParams} from "../types/PoolOperation.sol";
import {ParseBytes} from "./ParseBytes.sol";
import {CustomRevert} from "./CustomRevert.sol";
/// @notice V4 decides whether to invoke specific hooks by inspecting the least significant bits
/// of the address that the hooks contract is deployed to.
/// For example, a hooks contract deployed to address: 0x0000000000000000000000000000000000002400
/// has the lowest bits '10 0100 0000 0000' which would cause the 'before initialize' and 'after add liquidity' hooks to be used.
library Hooks {
using LPFeeLibrary for uint24;
using Hooks for IHooks;
using SafeCast for int256;
using BeforeSwapDeltaLibrary for BeforeSwapDelta;
using ParseBytes for bytes;
using CustomRevert for bytes4;
uint160 internal constant ALL_HOOK_MASK = uint160((1 << 14) - 1);
uint160 internal constant BEFORE_INITIALIZE_FLAG = 1 << 13;
uint160 internal constant AFTER_INITIALIZE_FLAG = 1 << 12;
uint160 internal constant BEFORE_ADD_LIQUIDITY_FLAG = 1 << 11;
uint160 internal constant AFTER_ADD_LIQUIDITY_FLAG = 1 << 10;
uint160 internal constant BEFORE_REMOVE_LIQUIDITY_FLAG = 1 << 9;
uint160 internal constant AFTER_REMOVE_LIQUIDITY_FLAG = 1 << 8;
uint160 internal constant BEFORE_SWAP_FLAG = 1 << 7;
uint160 internal constant AFTER_SWAP_FLAG = 1 << 6;
uint160 internal constant BEFORE_DONATE_FLAG = 1 << 5;
uint160 internal constant AFTER_DONATE_FLAG = 1 << 4;
uint160 internal constant BEFORE_SWAP_RETURNS_DELTA_FLAG = 1 << 3;
uint160 internal constant AFTER_SWAP_RETURNS_DELTA_FLAG = 1 << 2;
uint160 internal constant AFTER_ADD_LIQUIDITY_RETURNS_DELTA_FLAG = 1 << 1;
uint160 internal constant AFTER_REMOVE_LIQUIDITY_RETURNS_DELTA_FLAG = 1 << 0;
struct Permissions {
bool beforeInitialize;
bool afterInitialize;
bool beforeAddLiquidity;
bool afterAddLiquidity;
bool beforeRemoveLiquidity;
bool afterRemoveLiquidity;
bool beforeSwap;
bool afterSwap;
bool beforeDonate;
bool afterDonate;
bool beforeSwapReturnDelta;
bool afterSwapReturnDelta;
bool afterAddLiquidityReturnDelta;
bool afterRemoveLiquidityReturnDelta;
}
/// @notice Thrown if the address will not lead to the specified hook calls being called
/// @param hooks The address of the hooks contract
error HookAddressNotValid(address hooks);
/// @notice Hook did not return its selector
error InvalidHookResponse();
/// @notice Additional context for ERC-7751 wrapped error when a hook call fails
error HookCallFailed();
/// @notice The hook's delta changed the swap from exactIn to exactOut or vice versa
error HookDeltaExceedsSwapAmount();
/// @notice Utility function intended to be used in hook constructors to ensure
/// the deployed hooks address causes the intended hooks to be called
/// @param permissions The hooks that are intended to be called
/// @dev permissions param is memory as the function will be called from constructors
function validateHookPermissions(IHooks self, Permissions memory permissions) internal pure {
if (
permissions.beforeInitialize != self.hasPermission(BEFORE_INITIALIZE_FLAG)
|| permissions.afterInitialize != self.hasPermission(AFTER_INITIALIZE_FLAG)
|| permissions.beforeAddLiquidity != self.hasPermission(BEFORE_ADD_LIQUIDITY_FLAG)
|| permissions.afterAddLiquidity != self.hasPermission(AFTER_ADD_LIQUIDITY_FLAG)
|| permissions.beforeRemoveLiquidity != self.hasPermission(BEFORE_REMOVE_LIQUIDITY_FLAG)
|| permissions.afterRemoveLiquidity != self.hasPermission(AFTER_REMOVE_LIQUIDITY_FLAG)
|| permissions.beforeSwap != self.hasPermission(BEFORE_SWAP_FLAG)
|| permissions.afterSwap != self.hasPermission(AFTER_SWAP_FLAG)
|| permissions.beforeDonate != self.hasPermission(BEFORE_DONATE_FLAG)
|| permissions.afterDonate != self.hasPermission(AFTER_DONATE_FLAG)
|| permissions.beforeSwapReturnDelta != self.hasPermission(BEFORE_SWAP_RETURNS_DELTA_FLAG)
|| permissions.afterSwapReturnDelta != self.hasPermission(AFTER_SWAP_RETURNS_DELTA_FLAG)
|| permissions.afterAddLiquidityReturnDelta != self.hasPermission(AFTER_ADD_LIQUIDITY_RETURNS_DELTA_FLAG)
|| permissions.afterRemoveLiquidityReturnDelta
!= self.hasPermission(AFTER_REMOVE_LIQUIDITY_RETURNS_DELTA_FLAG)
) {
HookAddressNotValid.selector.revertWith(address(self));
}
}
/// @notice Ensures that the hook address includes at least one hook flag or dynamic fees, or is the 0 address
/// @param self The hook to verify
/// @param fee The fee of the pool the hook is used with
/// @return bool True if the hook address is valid
function isValidHookAddress(IHooks self, uint24 fee) internal pure returns (bool) {
// The hook can only have a flag to return a hook delta on an action if it also has the corresponding action flag
if (!self.hasPermission(BEFORE_SWAP_FLAG) && self.hasPermission(BEFORE_SWAP_RETURNS_DELTA_FLAG)) return false;
if (!self.hasPermission(AFTER_SWAP_FLAG) && self.hasPermission(AFTER_SWAP_RETURNS_DELTA_FLAG)) return false;
if (!self.hasPermission(AFTER_ADD_LIQUIDITY_FLAG) && self.hasPermission(AFTER_ADD_LIQUIDITY_RETURNS_DELTA_FLAG))
{
return false;
}
if (
!self.hasPermission(AFTER_REMOVE_LIQUIDITY_FLAG)
&& self.hasPermission(AFTER_REMOVE_LIQUIDITY_RETURNS_DELTA_FLAG)
) return false;
// If there is no hook contract set, then fee cannot be dynamic
// If a hook contract is set, it must have at least 1 flag set, or have a dynamic fee
return address(self) == address(0)
? !fee.isDynamicFee()
: (uint160(address(self)) & ALL_HOOK_MASK > 0 || fee.isDynamicFee());
}
/// @notice performs a hook call using the given calldata on the given hook that doesn't return a delta
/// @return result The complete data returned by the hook
function callHook(IHooks self, bytes memory data) internal returns (bytes memory result) {
bool success;
assembly ("memory-safe") {
success := call(gas(), self, 0, add(data, 0x20), mload(data), 0, 0)
}
// Revert with FailedHookCall, containing any error message to bubble up
if (!success) CustomRevert.bubbleUpAndRevertWith(address(self), bytes4(data), HookCallFailed.selector);
// The call was successful, fetch the returned data
assembly ("memory-safe") {
// allocate result byte array from the free memory pointer
result := mload(0x40)
// store new free memory pointer at the end of the array padded to 32 bytes
mstore(0x40, add(result, and(add(returndatasize(), 0x3f), not(0x1f))))
// store length in memory
mstore(result, returndatasize())
// copy return data to result
returndatacopy(add(result, 0x20), 0, returndatasize())
}
// Length must be at least 32 to contain the selector. Check expected selector and returned selector match.
if (result.length < 32 || result.parseSelector() != data.parseSelector()) {
InvalidHookResponse.selector.revertWith();
}
}
/// @notice performs a hook call using the given calldata on the given hook
/// @return int256 The delta returned by the hook
function callHookWithReturnDelta(IHooks self, bytes memory data, bool parseReturn) internal returns (int256) {
bytes memory result = callHook(self, data);
// If this hook wasn't meant to return something, default to 0 delta
if (!parseReturn) return 0;
// A length of 64 bytes is required to return a bytes4, and a 32 byte delta
if (result.length != 64) InvalidHookResponse.selector.revertWith();
return result.parseReturnDelta();
}
/// @notice modifier to prevent calling a hook if they initiated the action
modifier noSelfCall(IHooks self) {
if (msg.sender != address(self)) {
_;
}
}
/// @notice calls beforeInitialize hook if permissioned and validates return value
function beforeInitialize(IHooks self, PoolKey memory key, uint160 sqrtPriceX96) internal noSelfCall(self) {
if (self.hasPermission(BEFORE_INITIALIZE_FLAG)) {
self.callHook(abi.encodeCall(IHooks.beforeInitialize, (msg.sender, key, sqrtPriceX96)));
}
}
/// @notice calls afterInitialize hook if permissioned and validates return value
function afterInitialize(IHooks self, PoolKey memory key, uint160 sqrtPriceX96, int24 tick)
internal
noSelfCall(self)
{
if (self.hasPermission(AFTER_INITIALIZE_FLAG)) {
self.callHook(abi.encodeCall(IHooks.afterInitialize, (msg.sender, key, sqrtPriceX96, tick)));
}
}
/// @notice calls beforeModifyLiquidity hook if permissioned and validates return value
function beforeModifyLiquidity(
IHooks self,
PoolKey memory key,
ModifyLiquidityParams memory params,
bytes calldata hookData
) internal noSelfCall(self) {
if (params.liquidityDelta > 0 && self.hasPermission(BEFORE_ADD_LIQUIDITY_FLAG)) {
self.callHook(abi.encodeCall(IHooks.beforeAddLiquidity, (msg.sender, key, params, hookData)));
} else if (params.liquidityDelta <= 0 && self.hasPermission(BEFORE_REMOVE_LIQUIDITY_FLAG)) {
self.callHook(abi.encodeCall(IHooks.beforeRemoveLiquidity, (msg.sender, key, params, hookData)));
}
}
/// @notice calls afterModifyLiquidity hook if permissioned and validates return value
function afterModifyLiquidity(
IHooks self,
PoolKey memory key,
ModifyLiquidityParams memory params,
BalanceDelta delta,
BalanceDelta feesAccrued,
bytes calldata hookData
) internal returns (BalanceDelta callerDelta, BalanceDelta hookDelta) {
if (msg.sender == address(self)) return (delta, BalanceDeltaLibrary.ZERO_DELTA);
callerDelta = delta;
if (params.liquidityDelta > 0) {
if (self.hasPermission(AFTER_ADD_LIQUIDITY_FLAG)) {
hookDelta = BalanceDelta.wrap(
self.callHookWithReturnDelta(
abi.encodeCall(
IHooks.afterAddLiquidity, (msg.sender, key, params, delta, feesAccrued, hookData)
),
self.hasPermission(AFTER_ADD_LIQUIDITY_RETURNS_DELTA_FLAG)
)
);
callerDelta = callerDelta - hookDelta;
}
} else {
if (self.hasPermission(AFTER_REMOVE_LIQUIDITY_FLAG)) {
hookDelta = BalanceDelta.wrap(
self.callHookWithReturnDelta(
abi.encodeCall(
IHooks.afterRemoveLiquidity, (msg.sender, key, params, delta, feesAccrued, hookData)
),
self.hasPermission(AFTER_REMOVE_LIQUIDITY_RETURNS_DELTA_FLAG)
)
);
callerDelta = callerDelta - hookDelta;
}
}
}
/// @notice calls beforeSwap hook if permissioned and validates return value
function beforeSwap(IHooks self, PoolKey memory key, SwapParams memory params, bytes calldata hookData)
internal
returns (int256 amountToSwap, BeforeSwapDelta hookReturn, uint24 lpFeeOverride)
{
amountToSwap = params.amountSpecified;
if (msg.sender == address(self)) return (amountToSwap, BeforeSwapDeltaLibrary.ZERO_DELTA, lpFeeOverride);
if (self.hasPermission(BEFORE_SWAP_FLAG)) {
bytes memory result = callHook(self, abi.encodeCall(IHooks.beforeSwap, (msg.sender, key, params, hookData)));
// A length of 96 bytes is required to return a bytes4, a 32 byte delta, and an LP fee
if (result.length != 96) InvalidHookResponse.selector.revertWith();
// dynamic fee pools that want to override the cache fee, return a valid fee with the override flag. If override flag
// is set but an invalid fee is returned, the transaction will revert. Otherwise the current LP fee will be used
if (key.fee.isDynamicFee()) lpFeeOverride = result.parseFee();
// skip this logic for the case where the hook return is 0
if (self.hasPermission(BEFORE_SWAP_RETURNS_DELTA_FLAG)) {
hookReturn = BeforeSwapDelta.wrap(result.parseReturnDelta());
// any return in unspecified is passed to the afterSwap hook for handling
int128 hookDeltaSpecified = hookReturn.getSpecifiedDelta();
// Update the swap amount according to the hook's return, and check that the swap type doesn't change (exact input/output)
if (hookDeltaSpecified != 0) {
bool exactInput = amountToSwap < 0;
amountToSwap += hookDeltaSpecified;
if (exactInput ? amountToSwap > 0 : amountToSwap < 0) {
HookDeltaExceedsSwapAmount.selector.revertWith();
}
}
}
}
}
/// @notice calls afterSwap hook if permissioned and validates return value
function afterSwap(
IHooks self,
PoolKey memory key,
SwapParams memory params,
BalanceDelta swapDelta,
bytes calldata hookData,
BeforeSwapDelta beforeSwapHookReturn
) internal returns (BalanceDelta, BalanceDelta) {
if (msg.sender == address(self)) return (swapDelta, BalanceDeltaLibrary.ZERO_DELTA);
int128 hookDeltaSpecified = beforeSwapHookReturn.getSpecifiedDelta();
int128 hookDeltaUnspecified = beforeSwapHookReturn.getUnspecifiedDelta();
if (self.hasPermission(AFTER_SWAP_FLAG)) {
hookDeltaUnspecified += self.callHookWithReturnDelta(
abi.encodeCall(IHooks.afterSwap, (msg.sender, key, params, swapDelta, hookData)),
self.hasPermission(AFTER_SWAP_RETURNS_DELTA_FLAG)
).toInt128();
}
BalanceDelta hookDelta;
if (hookDeltaUnspecified != 0 || hookDeltaSpecified != 0) {
hookDelta = (params.amountSpecified < 0 == params.zeroForOne)
? toBalanceDelta(hookDeltaSpecified, hookDeltaUnspecified)
: toBalanceDelta(hookDeltaUnspecified, hookDeltaSpecified);
// the caller has to pay for (or receive) the hook's delta
swapDelta = swapDelta - hookDelta;
}
return (swapDelta, hookDelta);
}
/// @notice calls beforeDonate hook if permissioned and validates return value
function beforeDonate(IHooks self, PoolKey memory key, uint256 amount0, uint256 amount1, bytes calldata hookData)
internal
noSelfCall(self)
{
if (self.hasPermission(BEFORE_DONATE_FLAG)) {
self.callHook(abi.encodeCall(IHooks.beforeDonate, (msg.sender, key, amount0, amount1, hookData)));
}
}
/// @notice calls afterDonate hook if permissioned and validates return value
function afterDonate(IHooks self, PoolKey memory key, uint256 amount0, uint256 amount1, bytes calldata hookData)
internal
noSelfCall(self)
{
if (self.hasPermission(AFTER_DONATE_FLAG)) {
self.callHook(abi.encodeCall(IHooks.afterDonate, (msg.sender, key, amount0, amount1, hookData)));
}
}
function hasPermission(IHooks self, uint160 flag) internal pure returns (bool) {
return uint160(address(self)) & flag != 0;
}
}
contracts/lib/v4-periphery/lib/permit2/src/interfaces/IAllowanceTransfer.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {IEIP712} from "./IEIP712.sol";
/// @title AllowanceTransfer
/// @notice Handles ERC20 token permissions through signature based allowance setting and ERC20 token transfers by checking allowed amounts
/// @dev Requires user's token approval on the Permit2 contract
interface IAllowanceTransfer is IEIP712 {
/// @notice Thrown when an allowance on a token has expired.
/// @param deadline The timestamp at which the allowed amount is no longer valid
error AllowanceExpired(uint256 deadline);
/// @notice Thrown when an allowance on a token has been depleted.
/// @param amount The maximum amount allowed
error InsufficientAllowance(uint256 amount);
/// @notice Thrown when too many nonces are invalidated.
error ExcessiveInvalidation();
/// @notice Emits an event when the owner successfully invalidates an ordered nonce.
event NonceInvalidation(
address indexed owner, address indexed token, address indexed spender, uint48 newNonce, uint48 oldNonce
);
/// @notice Emits an event when the owner successfully sets permissions on a token for the spender.
event Approval(
address indexed owner, address indexed token, address indexed spender, uint160 amount, uint48 expiration
);
/// @notice Emits an event when the owner successfully sets permissions using a permit signature on a token for the spender.
event Permit(
address indexed owner,
address indexed token,
address indexed spender,
uint160 amount,
uint48 expiration,
uint48 nonce
);
/// @notice Emits an event when the owner sets the allowance back to 0 with the lockdown function.
event Lockdown(address indexed owner, address token, address spender);
/// @notice The permit data for a token
struct PermitDetails {
// ERC20 token address
address token;
// the maximum amount allowed to spend
uint160 amount;
// timestamp at which a spender's token allowances become invalid
uint48 expiration;
// an incrementing value indexed per owner,token,and spender for each signature
uint48 nonce;
}
/// @notice The permit message signed for a single token allowance
struct PermitSingle {
// the permit data for a single token alownce
PermitDetails details;
// address permissioned on the allowed tokens
address spender;
// deadline on the permit signature
uint256 sigDeadline;
}
/// @notice The permit message signed for multiple token allowances
struct PermitBatch {
// the permit data for multiple token allowances
PermitDetails[] details;
// address permissioned on the allowed tokens
address spender;
// deadline on the permit signature
uint256 sigDeadline;
}
/// @notice The saved permissions
/// @dev This info is saved per owner, per token, per spender and all signed over in the permit message
/// @dev Setting amount to type(uint160).max sets an unlimited approval
struct PackedAllowance {
// amount allowed
uint160 amount;
// permission expiry
uint48 expiration;
// an incrementing value indexed per owner,token,and spender for each signature
uint48 nonce;
}
/// @notice A token spender pair.
struct TokenSpenderPair {
// the token the spender is approved
address token;
// the spender address
address spender;
}
/// @notice Details for a token transfer.
struct AllowanceTransferDetails {
// the owner of the token
address from;
// the recipient of the token
address to;
// the amount of the token
uint160 amount;
// the token to be transferred
address token;
}
/// @notice A mapping from owner address to token address to spender address to PackedAllowance struct, which contains details and conditions of the approval.
/// @notice The mapping is indexed in the above order see: allowance[ownerAddress][tokenAddress][spenderAddress]
/// @dev The packed slot holds the allowed amount, expiration at which the allowed amount is no longer valid, and current nonce thats updated on any signature based approvals.
function allowance(address user, address token, address spender)
external
view
returns (uint160 amount, uint48 expiration, uint48 nonce);
/// @notice Approves the spender to use up to amount of the specified token up until the expiration
/// @param token The token to approve
/// @param spender The spender address to approve
/// @param amount The approved amount of the token
/// @param expiration The timestamp at which the approval is no longer valid
/// @dev The packed allowance also holds a nonce, which will stay unchanged in approve
/// @dev Setting amount to type(uint160).max sets an unlimited approval
function approve(address token, address spender, uint160 amount, uint48 expiration) external;
/// @notice Permit a spender to a given amount of the owners token via the owner's EIP-712 signature
/// @dev May fail if the owner's nonce was invalidated in-flight by invalidateNonce
/// @param owner The owner of the tokens being approved
/// @param permitSingle Data signed over by the owner specifying the terms of approval
/// @param signature The owner's signature over the permit data
function permit(address owner, PermitSingle memory permitSingle, bytes calldata signature) external;
/// @notice Permit a spender to the signed amounts of the owners tokens via the owner's EIP-712 signature
/// @dev May fail if the owner's nonce was invalidated in-flight by invalidateNonce
/// @param owner The owner of the tokens being approved
/// @param permitBatch Data signed over by the owner specifying the terms of approval
/// @param signature The owner's signature over the permit data
function permit(address owner, PermitBatch memory permitBatch, bytes calldata signature) external;
/// @notice Transfer approved tokens from one address to another
/// @param from The address to transfer from
/// @param to The address of the recipient
/// @param amount The amount of the token to transfer
/// @param token The token address to transfer
/// @dev Requires the from address to have approved at least the desired amount
/// of tokens to msg.sender.
function transferFrom(address from, address to, uint160 amount, address token) external;
/// @notice Transfer approved tokens in a batch
/// @param transferDetails Array of owners, recipients, amounts, and tokens for the transfers
/// @dev Requires the from addresses to have approved at least the desired amount
/// of tokens to msg.sender.
function transferFrom(AllowanceTransferDetails[] calldata transferDetails) external;
/// @notice Enables performing a "lockdown" of the sender's Permit2 identity
/// by batch revoking approvals
/// @param approvals Array of approvals to revoke.
function lockdown(TokenSpenderPair[] calldata approvals) external;
/// @notice Invalidate nonces for a given (token, spender) pair
/// @param token The token to invalidate nonces for
/// @param spender The spender to invalidate nonces for
/// @param newNonce The new nonce to set. Invalidates all nonces less than it.
/// @dev Can't invalidate more than 2**16 nonces per transaction.
function invalidateNonces(address token, address spender, uint48 newNonce) external;
}
contracts/lib/v4-core/src/libraries/LPFeeLibrary.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {CustomRevert} from "./CustomRevert.sol";
/// @notice Library of helper functions for a pools LP fee
library LPFeeLibrary {
using LPFeeLibrary for uint24;
using CustomRevert for bytes4;
/// @notice Thrown when the static or dynamic fee on a pool exceeds 100%.
error LPFeeTooLarge(uint24 fee);
/// @notice An lp fee of exactly 0b1000000... signals a dynamic fee pool. This isn't a valid static fee as it is > MAX_LP_FEE
uint24 public constant DYNAMIC_FEE_FLAG = 0x800000;
/// @notice the second bit of the fee returned by beforeSwap is used to signal if the stored LP fee should be overridden in this swap
// only dynamic-fee pools can return a fee via the beforeSwap hook
uint24 public constant OVERRIDE_FEE_FLAG = 0x400000;
/// @notice mask to remove the override fee flag from a fee returned by the beforeSwaphook
uint24 public constant REMOVE_OVERRIDE_MASK = 0xBFFFFF;
/// @notice the lp fee is represented in hundredths of a bip, so the max is 100%
uint24 public constant MAX_LP_FEE = 1000000;
/// @notice returns true if a pool's LP fee signals that the pool has a dynamic fee
/// @param self The fee to check
/// @return bool True of the fee is dynamic
function isDynamicFee(uint24 self) internal pure returns (bool) {
return self == DYNAMIC_FEE_FLAG;
}
/// @notice returns true if an LP fee is valid, aka not above the maximum permitted fee
/// @param self The fee to check
/// @return bool True of the fee is valid
function isValid(uint24 self) internal pure returns (bool) {
return self <= MAX_LP_FEE;
}
/// @notice validates whether an LP fee is larger than the maximum, and reverts if invalid
/// @param self The fee to validate
function validate(uint24 self) internal pure {
if (!self.isValid()) LPFeeTooLarge.selector.revertWith(self);
}
/// @notice gets and validates the initial LP fee for a pool. Dynamic fee pools have an initial fee of 0.
/// @dev if a dynamic fee pool wants a non-0 initial fee, it should call `updateDynamicLPFee` in the afterInitialize hook
/// @param self The fee to get the initial LP from
/// @return initialFee 0 if the fee is dynamic, otherwise the fee (if valid)
function getInitialLPFee(uint24 self) internal pure returns (uint24) {
// the initial fee for a dynamic fee pool is 0
if (self.isDynamicFee()) return 0;
self.validate();
return self;
}
/// @notice returns true if the fee has the override flag set (2nd highest bit of the uint24)
/// @param self The fee to check
/// @return bool True of the fee has the override flag set
function isOverride(uint24 self) internal pure returns (bool) {
return self & OVERRIDE_FEE_FLAG != 0;
}
/// @notice returns a fee with the override flag removed
/// @param self The fee to remove the override flag from
/// @return fee The fee without the override flag set
function removeOverrideFlag(uint24 self) internal pure returns (uint24) {
return self & REMOVE_OVERRIDE_MASK;
}
/// @notice Removes the override flag and validates the fee (reverts if the fee is too large)
/// @param self The fee to remove the override flag from, and then validate
/// @return fee The fee without the override flag set (if valid)
function removeOverrideFlagAndValidate(uint24 self) internal pure returns (uint24 fee) {
fee = self.removeOverrideFlag();
fee.validate();
}
}
contracts/lib/openzeppelin-contracts/contracts/interfaces/IERC165.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC165.sol)
pragma solidity >=0.4.16;
import {IERC165} from "../utils/introspection/IERC165.sol";
contracts/lib/openzeppelin-contracts/contracts/interfaces/IERC1363.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC1363.sol)
pragma solidity >=0.6.2;
import {IERC20} from "./IERC20.sol";
import {IERC165} from "./IERC165.sol";
/**
* @title IERC1363
* @dev Interface of the ERC-1363 standard as defined in the https://eips.ethereum.org/EIPS/eip-1363[ERC-1363].
*
* Defines an extension interface for ERC-20 tokens that supports executing code on a recipient contract
* after `transfer` or `transferFrom`, or code on a spender contract after `approve`, in a single transaction.
*/
interface IERC1363 is IERC20, IERC165 {
/*
* Note: the ERC-165 identifier for this interface is 0xb0202a11.
* 0xb0202a11 ===
* bytes4(keccak256('transferAndCall(address,uint256)')) ^
* bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^
* bytes4(keccak256('approveAndCall(address,uint256)')) ^
* bytes4(keccak256('approveAndCall(address,uint256,bytes)'))
*/
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @param data Additional data with no specified format, sent in call to `spender`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool);
}
contracts/lib/v4-periphery/src/interfaces/IERC721Permit_v4.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title IERC721Permit_v4
/// @notice Interface for the ERC721Permit_v4 contract
interface IERC721Permit_v4 {
error SignatureDeadlineExpired();
error NoSelfPermit();
error Unauthorized();
/// @notice Approve of a specific token ID for spending by spender via signature
/// @param spender The account that is being approved
/// @param tokenId The ID of the token that is being approved for spending
/// @param deadline The deadline timestamp by which the call must be mined for the approve to work
/// @param nonce a unique value, for an owner, to prevent replay attacks; an unordered nonce where the top 248 bits correspond to a word and the bottom 8 bits calculate the bit position of the word
/// @param signature Concatenated data from a valid secp256k1 signature from the holder, i.e. abi.encodePacked(r, s, v)
/// @dev payable so it can be multicalled with NATIVE related actions
function permit(address spender, uint256 tokenId, uint256 deadline, uint256 nonce, bytes calldata signature)
external
payable;
/// @notice Set an operator with full permission to an owner's tokens via signature
/// @param owner The address that is setting the operator
/// @param operator The address that will be set as an operator for the owner
/// @param approved The permission to set on the operator
/// @param deadline The deadline timestamp by which the call must be mined for the approve to work
/// @param nonce a unique value, for an owner, to prevent replay attacks; an unordered nonce where the top 248 bits correspond to a word and the bottom 8 bits calculate the bit position of the word
/// @param signature Concatenated data from a valid secp256k1 signature from the holder, i.e. abi.encodePacked(r, s, v)
/// @dev payable so it can be multicalled with NATIVE related actions
function permitForAll(
address owner,
address operator,
bool approved,
uint256 deadline,
uint256 nonce,
bytes calldata signature
) external payable;
}
contracts/lib/v4-core/src/interfaces/IExttload.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
/// @notice Interface for functions to access any transient storage slot in a contract
interface IExttload {
/// @notice Called by external contracts to access transient storage of the contract
/// @param slot Key of slot to tload
/// @return value The value of the slot as bytes32
function exttload(bytes32 slot) external view returns (bytes32 value);
/// @notice Called by external contracts to access sparse transient pool state
/// @param slots List of slots to tload
/// @return values List of loaded values
function exttload(bytes32[] calldata slots) external view returns (bytes32[] memory values);
}
contracts/src/v2/hooks/PonsV2MemeHook.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {Ownable2Step} from "@openzeppelin/contracts/access/Ownable2Step.sol";
import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import {SafeCast} from "@openzeppelin/contracts/utils/math/SafeCast.sol";
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {IHooks} from "@uniswap/v4-core/src/interfaces/IHooks.sol";
import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
import {IUnlockCallback} from "@uniswap/v4-core/src/interfaces/callback/IUnlockCallback.sol";
import {Hooks} from "@uniswap/v4-core/src/libraries/Hooks.sol";
import {StateLibrary} from "@uniswap/v4-core/src/libraries/StateLibrary.sol";
import {TickMath} from "@uniswap/v4-core/src/libraries/TickMath.sol";
import {FullMath} from "@uniswap/v4-core/src/libraries/FullMath.sol";
import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
import {PoolId} from "@uniswap/v4-core/src/types/PoolId.sol";
import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
import {BalanceDelta} from "@uniswap/v4-core/src/types/BalanceDelta.sol";
import {SwapParams} from "@uniswap/v4-core/src/types/PoolOperation.sol";
import {BaseHook} from "@uniswap/v4-hooks-public/src/base/BaseHook.sol";
import {PonsV2BuybackVault} from "../PonsV2BuybackVault.sol";
import {FeePolicySnapshot, IPonsV2FeeEscrow, IPonsV2FeePolicy} from "../interfaces/ILaunchpadV2.sol";
/**
* @title PonsV2MemeHook
* @notice Singleton Uniswap V4 hook shared by every graduated pons v2 pool.
* Takes a fee cut on every swap via `afterSwap` (Flaunch-style Internal Swap
* Pool), and whenever that cut lands in the memecoin, converts it back to
* the pool's quote currency (ETH for the common native pairToken, or the
* launch's chosen ERC-20 pairToken otherwise) against the pool's own
* liquidity before it is ever distributed. The same protocol / creator /
* buyback-and-burn split that governs PonsV2BondingCurve's pre-graduation
* fee sweep lives here, read live by the curve through IPonsV2FeePolicy so
* both phases behave identically.
*/
contract PonsV2MemeHook is BaseHook, IUnlockCallback, IPonsV2FeePolicy, Ownable2Step, ReentrancyGuard {
using SafeERC20 for IERC20;
enum SwapDirection {
MemecoinToQuote,
QuoteToMemecoin
}
struct LaunchInfo {
bool registered;
bool memecoinIsCurrency0;
address memecoin;
address quoteToken; // address(0) denotes native ETH
address creator;
// Buyback locks retain this recipient even when future immediate
// creator payouts are transferred to a different address.
address buybackCreatorRecipient;
address protocolFeeRecipient;
// Creator-chosen at launch on PonsV2LaunchFactory, snapshotted here
// at registerPool time. Charged the same way hookFeeBps is, but paid
// entirely to the creator, bypassing the protocol/buyback split.
uint16 creatorTaxBps;
uint16 protocolFeeShareBps;
uint16 buybackBurnBps;
uint16 hookFeeBps;
uint16 maxInternalPriceImpactBps;
bool buybackEnabled;
}
uint256 private constant BASIS_POINTS = 10_000;
uint256 private constant MAX_PROTOCOL_FEE_SHARE_BPS = 5_000;
uint256 private constant MAX_HOOK_FEE_BPS = 1_000;
// Mirrors PonsV2BondingCurve's own ceiling, so a graduated pool can never
// charge more per trade than the curve it graduated from.
uint256 private constant MAX_TOTAL_TRADE_FEE_BPS = 2_000;
error NotFactory();
error AlreadySet();
error OwnershipCannotBeRenounced();
error ZeroAddress();
error InvalidBps();
error AlreadyRegistered();
error UnknownPool();
error InvalidPoolKey();
error NotFeeSweepOperator();
error InternalSwapRequiresOperator();
error SlippageExceeded(uint256 actual, uint256 minimum);
error MinimumOutputRequired();
error InexactQuoteTransfer(address token, uint256 expected, uint256 received);
error NothingToRescue();
event FactorySet(address factory);
event PoolRegistered(PoolId indexed poolId, address memecoin, address quoteToken, address creator);
event CreatorFeeRecipientUpdated(
PoolId indexed poolId, address indexed previousRecipient, address indexed newRecipient
);
// Reported separately because the two accrue to different ledgers: the
// fee splits across protocol, buyback and creator on sweep, while the tax
// is paid to the creator in full.
event HookFeeCollected(PoolId indexed poolId, address currency, uint256 feeAmount, uint256 taxAmount);
event PoolFeesSwept(
PoolId indexed poolId,
uint256 protocolAmount,
uint256 buybackAmount,
uint256 creatorAmount,
uint256 tokensLocked
);
event PoolFeesRescued(
PoolId indexed poolId, address indexed quoteToken, uint256 protocolAmount, uint256 creatorAmount
);
event PoolBuybackSkipped(PoolId indexed poolId, uint256 foldedBackQuote);
event PoolConversionSkipped(PoolId indexed poolId, uint256 retainedMemecoin);
event BuybackVaultSet(address vault);
event ProtocolFeeShareUpdated(uint256 bps);
event BuybackBurnBpsUpdated(uint256 bps);
event HookFeeBpsUpdated(uint256 bps);
event MaxInternalPriceImpactUpdated(uint256 bps);
event ProtocolFeeRecipientUpdated(address recipient);
event FeeSweepOperatorUpdated(address operator);
event BuybackEnabledUpdated(PoolId indexed poolId, bool enabled);
IPonsV2FeeEscrow public immutable feeEscrow;
address public factory;
PonsV2BuybackVault public buybackVault;
address public protocolFeeRecipient;
uint256 public protocolFeeShareBps;
uint256 public buybackBurnBps;
uint256 public hookFeeBps;
uint256 public maxInternalPriceImpactBps;
address public feeSweepOperator;
mapping(PoolId => LaunchInfo) public launches;
mapping(PoolId => PoolKey) private _poolKeys;
mapping(PoolId => mapping(address currency => uint256 amount)) public pendingFees;
// Tracked separately from pendingFees so the creator tax never enters
// the protocol/buyback split math; it is folded straight into the
// creator's payout at sweep time.
mapping(PoolId => mapping(address currency => uint256 amount)) public pendingCreatorTax;
// The slice of pendingFees already earmarked for buyback-and-lock, set
// aside as each swap's fee was charged under whatever the pool's buyback
// flag said at that moment. Bucketing at accrual rather than deriving the
// slice at sweep time keeps the flag forward-looking: toggling it decides
// how the next swap's fee is split, never how an already-charged one is.
// Held per currency and carried across the memecoin-to-quote conversion
// in proportion to the fee it rode in on, so an earmark accrued in the
// memecoin still reaches the vest.
mapping(PoolId => mapping(address currency => uint256 amount)) public pendingBuyback;
modifier onlyFactory() {
if (msg.sender != factory) revert NotFactory();
_;
}
/**
* @param poolManager_ The canonical Uniswap V4 pool manager.
* @param feeEscrow_ Shared claimable balance ledger, also used by every bonding curve.
* @param protocolFeeRecipient_ Escrow key credited with the protocol's share.
* @param initialOwner_ Protocol deployer; the only address that can ever change fee policy.
*/
constructor(
IPoolManager poolManager_,
IPonsV2FeeEscrow feeEscrow_,
address protocolFeeRecipient_,
address initialOwner_
) BaseHook(poolManager_) Ownable(initialOwner_) {
if (address(poolManager_) == address(0) || address(feeEscrow_) == address(0)) {
revert ZeroAddress();
}
if (protocolFeeRecipient_ == address(0)) revert ZeroAddress();
feeEscrow = feeEscrow_;
protocolFeeRecipient = protocolFeeRecipient_;
protocolFeeShareBps = 3_000;
buybackBurnBps = 5_000;
hookFeeBps = 100;
maxInternalPriceImpactBps = 300;
feeSweepOperator = initialOwner_;
}
/**
* @notice Only `afterSwap` is enabled: fee collection happens once per
* swap, after the pool's own core swap math has already run.
*/
function getHookPermissions() public pure override returns (Hooks.Permissions memory) {
return Hooks.Permissions({
beforeInitialize: true,
afterInitialize: false,
beforeAddLiquidity: false,
afterAddLiquidity: false,
beforeRemoveLiquidity: false,
afterRemoveLiquidity: false,
beforeSwap: false,
afterSwap: true,
beforeDonate: false,
afterDonate: false,
beforeSwapReturnDelta: false,
afterSwapReturnDelta: true,
afterAddLiquidityReturnDelta: false,
afterRemoveLiquidityReturnDelta: false
});
}
// ---------------------------------------------------------------------
// Owner-only configuration
// ---------------------------------------------------------------------
/**
* @notice One-time wiring of the v2 factory, set after both are deployed
* since the factory needs this hook's mined address to build pool keys.
*/
function setFactory(address factory_) external onlyOwner {
if (factory != address(0)) revert AlreadySet();
if (factory_ == address(0)) revert ZeroAddress();
factory = factory_;
emit FactorySet(factory_);
}
/**
* @notice One-time wiring of the shared five-year buyback vest, set
* after both are deployed, so `_distribute` can lock the buyback leg
* into it instead of burning it.
*/
function setBuybackVault(PonsV2BuybackVault buybackVault_) external onlyOwner {
if (address(buybackVault) != address(0)) revert AlreadySet();
if (address(buybackVault_) == address(0)) revert ZeroAddress();
buybackVault = buybackVault_;
emit BuybackVaultSet(address(buybackVault_));
}
/**
* @notice Permanently disabled. An ownerless hook could never rotate the
* fee sweep operator, so accrued fees on every graduated pool would stay
* stranded. Ownership can still be transferred to a new owner.
*/
function renounceOwnership() public pure override {
revert OwnershipCannotBeRenounced();
}
function setProtocolFeeShareBps(uint256 bps) external onlyOwner {
if (bps > MAX_PROTOCOL_FEE_SHARE_BPS) revert InvalidBps();
protocolFeeShareBps = bps;
emit ProtocolFeeShareUpdated(bps);
}
function setBuybackBurnBps(uint256 bps) external onlyOwner {
if (bps > BASIS_POINTS) revert InvalidBps();
buybackBurnBps = bps;
emit BuybackBurnBpsUpdated(bps);
}
function setHookFeeBps(uint256 bps) external onlyOwner {
if (bps > MAX_HOOK_FEE_BPS) revert InvalidBps();
hookFeeBps = bps;
emit HookFeeBpsUpdated(bps);
}
function setMaxInternalPriceImpactBps(uint256 bps) external onlyOwner {
if (bps == 0 || bps >= BASIS_POINTS) revert InvalidBps();
maxInternalPriceImpactBps = bps;
emit MaxInternalPriceImpactUpdated(bps);
}
function setProtocolFeeRecipient(address recipient) external onlyOwner {
if (recipient == address(0)) revert ZeroAddress();
protocolFeeRecipient = recipient;
emit ProtocolFeeRecipientUpdated(recipient);
}
/**
* @notice Sets the trusted operator that executes fee conversions with
* explicit minimum outputs, preventing arbitrary callers from triggering
* predictable swaps against a manipulated spot price.
*/
function setFeeSweepOperator(address operator) external onlyOwner {
if (operator == address(0)) revert ZeroAddress();
feeSweepOperator = operator;
emit FeeSweepOperatorUpdated(operator);
}
/**
* @notice Returns the policy terms new launches snapshot immutably.
*/
function currentFeePolicy() external view override returns (FeePolicySnapshot memory) {
return _currentFeePolicy();
}
function _currentFeePolicy() private view returns (FeePolicySnapshot memory) {
return FeePolicySnapshot({
protocolFeeRecipient: protocolFeeRecipient,
protocolFeeShareBps: uint16(protocolFeeShareBps),
buybackBurnBps: uint16(buybackBurnBps),
hookFeeBps: uint16(hookFeeBps),
maxInternalPriceImpactBps: uint16(maxInternalPriceImpactBps)
});
}
// ---------------------------------------------------------------------
// Factory wiring
// ---------------------------------------------------------------------
/**
* @notice Registers a pool with fee terms frozen at launch by the factory.
* @dev `buybackCreatorRecipient` is the creator recipient the curve was
* constructed with, passed so the vest this pool tops up lands in the
* same vault epoch as any tranche the curve locked pre-graduation.
*
* It is not immutable in effect. The vault only reads it to seed an empty
* slot, and the factory forwards every later creator-fee-recipient
* rotation into `updateCreatorRecipient`, so the live beneficiary follows
* the creator fee stream. That is deliberate: it is what lets a
* compromised creator key be recovered without orphaning the vest.
*/
function registerPool(
PoolKey calldata key,
address memecoin,
address creator,
address buybackCreatorRecipient,
uint16 creatorTaxBps,
bool buybackEnabled,
FeePolicySnapshot calldata policy
) external onlyFactory {
_registerPool(key, memecoin, creator, buybackCreatorRecipient, creatorTaxBps, buybackEnabled, policy);
}
function _registerPool(
PoolKey calldata key,
address memecoin,
address creator,
address buybackCreatorRecipient,
uint16 creatorTaxBps,
bool buybackEnabled,
FeePolicySnapshot memory policy
) private {
PoolId poolId = key.toId();
if (launches[poolId].registered) revert AlreadyRegistered();
if (creator == address(0) || buybackCreatorRecipient == address(0)) revert ZeroAddress();
// Terms frozen here govern the pool for life, so each is held to the
// same ceiling as the setter that produced it. protocolFeeShareBps
// against BASIS_POINTS rather than MAX_PROTOCOL_FEE_SHARE_BPS would
// let a pool be registered on terms the live policy could never
// reach, paying the creator nothing.
if (
policy.protocolFeeRecipient == address(0) || policy.protocolFeeShareBps > MAX_PROTOCOL_FEE_SHARE_BPS
|| policy.buybackBurnBps > BASIS_POINTS || policy.hookFeeBps > MAX_HOOK_FEE_BPS
|| policy.maxInternalPriceImpactBps == 0 || policy.maxInternalPriceImpactBps >= BASIS_POINTS
) {
revert InvalidBps();
}
// The curve bounds the same sum in its own constructor rather than
// inheriting it from the factory. A pool taking more than the whole
// unspecified leg would flip the swapper's output delta negative.
if (uint256(creatorTaxBps) + policy.hookFeeBps > MAX_TOTAL_TRADE_FEE_BPS) revert InvalidBps();
// The factory builds the key correctly today, but these two facts are
// what every later fee credit and swap direction is derived from. A
// memecoin that is neither currency would silently designate the wrong
// side as quote and route fees to a slot nothing ever reads.
if (address(key.hooks) != address(this)) revert InvalidPoolKey();
bool memecoinIsCurrency0 = Currency.unwrap(key.currency0) == memecoin;
if (!memecoinIsCurrency0 && Currency.unwrap(key.currency1) != memecoin) revert InvalidPoolKey();
address quoteToken = memecoinIsCurrency0 ? Currency.unwrap(key.currency1) : Currency.unwrap(key.currency0);
launches[poolId] = LaunchInfo({
registered: true,
memecoinIsCurrency0: memecoinIsCurrency0,
memecoin: memecoin,
quoteToken: quoteToken,
creator: creator,
buybackCreatorRecipient: buybackCreatorRecipient,
protocolFeeRecipient: policy.protocolFeeRecipient,
creatorTaxBps: creatorTaxBps,
protocolFeeShareBps: policy.protocolFeeShareBps,
buybackBurnBps: policy.buybackBurnBps,
hookFeeBps: policy.hookFeeBps,
maxInternalPriceImpactBps: policy.maxInternalPriceImpactBps,
buybackEnabled: buybackEnabled
});
_poolKeys[poolId] = key;
emit PoolRegistered(poolId, memecoin, quoteToken, creator);
}
/**
* @notice Updates who receives this pool's creator fee share. Restricted
* to the factory, which gates both self-service creator transfers and
* protocol-owner overrides before forwarding here, so this contract only
* needs to trust one caller.
*/
function setCreatorFeeRecipient(PoolId poolId, address newRecipient) external onlyFactory {
LaunchInfo storage info = launches[poolId];
if (!info.registered) revert UnknownPool();
if (newRecipient == address(0)) revert ZeroAddress();
emit CreatorFeeRecipientUpdated(poolId, info.creator, newRecipient);
info.creator = newRecipient;
}
/**
* @notice Updates whether a registered launch routes its configured fee
* share through buyback-and-lock.
* @dev Applies to fees charged from here on, not to fees already pending.
* Each swap earmarks its buyback slice as it is charged, so a toggle
* cannot reach back and reroute value that accrued under the opposite
* setting. Without that, a disable landing before a sweep would divert a
* buyback the creator had already earned into their own payout, and an
* enable would sweep fees earned under a plain split into the vest.
*/
function setBuybackEnabled(PoolId poolId, bool enabled) external onlyFactory {
LaunchInfo storage info = launches[poolId];
if (!info.registered) revert UnknownPool();
info.buybackEnabled = enabled;
emit BuybackEnabledUpdated(poolId, enabled);
}
// ---------------------------------------------------------------------
// IHooks: only beforeInitialize and afterSwap are enabled. BaseHook
// supplies the externally reachable callbacks, each already restricted to
// the pool manager, and reverts HookNotImplemented for every permission
// getHookPermissions() leaves off.
// ---------------------------------------------------------------------
/**
* @dev Registration is what binds a pool id to its memecoin, quote asset,
* and fee recipients, and every later fee credit is derived from that
* record. Restricting initialization to the factory keeps a pool bearing
* this hook from existing without one.
*/
function _beforeInitialize(address sender, PoolKey calldata, uint160) internal view override returns (bytes4) {
if (sender != factory) revert NotFactory();
return IHooks.beforeInitialize.selector;
}
/**
* @notice Takes `hookFeeBps` plus this pool's `creatorTaxBps` of the
* swap's unspecified currency straight out of the pool manager's
* flash-accounting ledger in a single `take`, crediting the two cuts to
* separate pending balances so the creator tax never mixes with the
* protocol/buyback-and-lock split. If either cut lands in the
* memecoin, it is left untouched here and only converted to the quote
* currency later, in a batched `sweepPoolFees` call, rather than on
* every single swap.
*/
function _afterSwap(address, PoolKey calldata key, SwapParams calldata params, BalanceDelta delta, bytes calldata)
internal
override
returns (bytes4, int128)
{
// The conversion and buyback legs swap against this same pool, but
// they are never taxed here: v4-core skips a pool's hooks when the
// hook itself is the caller (Hooks.afterSwap). Were that not so, the
// skim would come out of the buyback before it reached the vault.
PoolId poolId = key.toId();
LaunchInfo memory info = launches[poolId];
if (!info.registered) return (IHooks.afterSwap.selector, 0);
if (info.hookFeeBps == 0 && info.creatorTaxBps == 0) return (IHooks.afterSwap.selector, 0);
bool specifiedIsCurrency0 = (params.amountSpecified < 0) == params.zeroForOne;
(Currency feeCurrency, int128 unspecifiedAmount) =
specifiedIsCurrency0 ? (key.currency1, delta.amount1()) : (key.currency0, delta.amount0());
if (unspecifiedAmount < 0) unspecifiedAmount = -unspecifiedAmount;
if (unspecifiedAmount == 0) return (IHooks.afterSwap.selector, 0);
uint256 unspecified = uint256(uint128(unspecifiedAmount));
uint256 feeAmount = (unspecified * info.hookFeeBps) / BASIS_POINTS;
uint256 taxAmount = (unspecified * info.creatorTaxBps) / BASIS_POINTS;
uint256 totalAmount = feeAmount + taxAmount;
if (totalAmount == 0) return (IHooks.afterSwap.selector, 0);
address feeCurrencyAddr = Currency.unwrap(feeCurrency);
_takeExact(feeCurrency, feeCurrencyAddr, totalAmount);
if (feeAmount != 0) {
pendingFees[poolId][feeCurrencyAddr] += feeAmount;
if (info.buybackEnabled) {
// The buyback comes out of the creator's bucket alone, so it
// is measured against what remains after the protocol's share.
uint256 creatorSlice = feeAmount - (feeAmount * info.protocolFeeShareBps) / BASIS_POINTS;
pendingBuyback[poolId][feeCurrencyAddr] += (creatorSlice * info.buybackBurnBps) / BASIS_POINTS;
}
}
if (taxAmount != 0) pendingCreatorTax[poolId][feeCurrencyAddr] += taxAmount;
emit HookFeeCollected(poolId, feeCurrencyAddr, feeAmount, taxAmount);
return (IHooks.afterSwap.selector, int128(uint128(totalAmount)));
}
// ---------------------------------------------------------------------
// Fee sweep: ISP conversion, buyback-and-lock, and distribution
// ---------------------------------------------------------------------
/**
* @notice Converts any pending memecoin-denominated fee into the pool's
* quote currency against the pool's own liquidity, then splits the
* combined quote-currency total into protocol / buyback-and-lock /
* creator using the live policy, exactly mirroring the bonding curve's
* own sweep. The trusted sweep operator is required whenever the sweep
* would execute an internal conversion or buyback. The creator may still
* distribute already-quoted fees when no internal swap is needed.
*/
function sweepPoolFees(PoolId poolId, uint256 minConversionQuoteOut, uint256 minBuybackTokensOut)
external
nonReentrant
{
LaunchInfo memory info = launches[poolId];
if (!info.registered) revert UnknownPool();
bool isOperator = msg.sender == feeSweepOperator;
if (!isOperator && msg.sender != info.creator) revert NotFeeSweepOperator();
if (!isOperator && _requiresTrustedOperator(poolId, info)) revert InternalSwapRequiresOperator();
(uint256 convertedFeeQuote, uint256 convertedTaxQuote, uint256 convertedBuybackQuote, bool converted) =
_convertPendingMemecoin(poolId, info, minConversionQuoteOut);
// Only a conversion that actually executed is subject to the caller's
// minimum. Enforcing it when there was nothing to convert, or when the
// swap filled nothing and the pending amount was restored for a later
// retry, would block the quote-denominated legs of the sweep over a
// conversion that never happened.
uint256 conversionQuoteOut = convertedFeeQuote + convertedTaxQuote;
if (converted && conversionQuoteOut < minConversionQuoteOut) {
revert SlippageExceeded(conversionQuoteOut, minConversionQuoteOut);
}
uint256 totalQuote = pendingFees[poolId][info.quoteToken] + convertedFeeQuote;
uint256 taxQuote = pendingCreatorTax[poolId][info.quoteToken] + convertedTaxQuote;
uint256 buybackQuote = pendingBuyback[poolId][info.quoteToken] + convertedBuybackQuote;
if (totalQuote == 0 && taxQuote == 0) return;
pendingFees[poolId][info.quoteToken] = 0;
pendingCreatorTax[poolId][info.quoteToken] = 0;
pendingBuyback[poolId][info.quoteToken] = 0;
_distribute(poolId, info, totalQuote, taxQuote, buybackQuote, minBuybackTokensOut);
}
/**
* @notice Owner-only escape hatch for a pool's pending quote-token fees
* when they can no longer reach the protocol and creator through the
* normal exact-delivery path, for example an approved pair token that
* later turns out to be fee-on-transfer, rebasing, or otherwise unable
* to move its exact nominal amount. `sweepPoolFees` would revert
* indefinitely in that case, since `_payOut` enforces exact delivery
* into the fee escrow and there is no way to satisfy it. This bypasses
* the escrow and the buyback conversion entirely (the buyback swap
* would fail for the same underlying reason) and pays the protocol and
* creator their regular split with a direct transfer instead, so the
* quote-token balance the hook already holds is never permanently
* stuck. A native quote leg is skipped rather than rejected: ETH cannot
* fail an exact-delivery transfer, so it has nothing to rescue.
*
* The pool's memecoin-denominated fees are rescued regardless of what the
* quote currency is, because their only ordinary exit is the conversion
* swap. Gating the whole function on an ERC-20 quote would leave a native
* pool's memecoin fees with no recovery at all, and would also strand its
* ETH fees behind them, since sweepPoolFees converts before it
* distributes and reverts as a unit.
*/
function rescuePoolFees(PoolId poolId)
external
onlyOwner
nonReentrant
returns (uint256 protocolAmount, uint256 creatorAmount)
{
LaunchInfo memory info = launches[poolId];
if (!info.registered) revert UnknownPool();
address quoteToken = info.quoteToken;
if (quoteToken != address(0)) {
(protocolAmount, creatorAmount) = _rescueCurrency(poolId, info, quoteToken);
}
(uint256 memecoinProtocol, uint256 memecoinCreator) = _rescueCurrency(poolId, info, info.memecoin);
if (protocolAmount == 0 && creatorAmount == 0 && memecoinProtocol == 0 && memecoinCreator == 0) {
revert NothingToRescue();
}
}
/**
* @dev Zeroes one currency's pending buckets for a pool and pays the
* protocol and creator their regular split directly, bypassing the
* escrow. Returns zero for both legs when there is nothing pending, so
* the caller can tell whether any currency had a balance to rescue.
*/
function _rescueCurrency(PoolId poolId, LaunchInfo memory info, address currency)
private
returns (uint256 protocolAmount, uint256 creatorAmount)
{
uint256 total = pendingFees[poolId][currency];
uint256 tax = pendingCreatorTax[poolId][currency];
if (total == 0 && tax == 0) return (0, 0);
pendingFees[poolId][currency] = 0;
pendingCreatorTax[poolId][currency] = 0;
// The rescue pays the creator their whole bucket rather than running
// a buyback, since the swap would fail for the same reason the escrow
// path did. Clearing the earmark keeps it from surviving as a claim
// on fees this call has already paid out.
pendingBuyback[poolId][currency] = 0;
protocolAmount = (total * info.protocolFeeShareBps) / BASIS_POINTS;
creatorAmount = total - protocolAmount + tax;
if (protocolAmount != 0) IERC20(currency).safeTransfer(info.protocolFeeRecipient, protocolAmount);
if (creatorAmount != 0) IERC20(currency).safeTransfer(info.creator, creatorAmount);
emit PoolFeesRescued(poolId, currency, protocolAmount, creatorAmount);
}
/**
* @dev Limits price-sensitive pool interactions to the protocol's sweep
* operator. A creator can distribute direct quote balances when buyback is
* disabled, but cannot select a permissive minimum around a manipulable
* spot price for inventory shared with the protocol.
*/
function _requiresTrustedOperator(PoolId poolId, LaunchInfo memory info) private view returns (bool) {
if (pendingFees[poolId][info.memecoin] != 0 || pendingCreatorTax[poolId][info.memecoin] != 0) {
return true;
}
return pendingBuyback[poolId][info.quoteToken] != 0;
}
/**
* @dev Converts fee and creator-tax memecoin inventory in one swap so the
* sweep receives one aggregate price boundary. Partial input and output
* are allocated proportionally back to their separate accounting buckets.
* The buyback earmark rides along inside the fee bucket, converting in
* the same proportion so a partial fill leaves the unconverted remainder
* carrying the share of the earmark it still owes.
*/
function _convertPendingMemecoin(PoolId poolId, LaunchInfo memory info, uint256 minConversionQuoteOut)
private
returns (uint256 feeQuoteOut, uint256 taxQuoteOut, uint256 buybackQuoteOut, bool converted)
{
uint256 feePending = pendingFees[poolId][info.memecoin];
uint256 taxPending = pendingCreatorTax[poolId][info.memecoin];
uint256 buybackPending = pendingBuyback[poolId][info.memecoin];
uint256 totalPending = feePending + taxPending;
if (totalPending == 0) return (0, 0, 0, false);
if (minConversionQuoteOut == 0) revert MinimumOutputRequired();
pendingFees[poolId][info.memecoin] = 0;
pendingCreatorTax[poolId][info.memecoin] = 0;
pendingBuyback[poolId][info.memecoin] = 0;
(uint256 consumed, uint256 quoteOut) = _executeInternalSwap(poolId, SwapDirection.MemecoinToQuote, totalPending);
if (consumed == 0) {
pendingFees[poolId][info.memecoin] += feePending;
pendingCreatorTax[poolId][info.memecoin] += taxPending;
pendingBuyback[poolId][info.memecoin] += buybackPending;
emit PoolConversionSkipped(poolId, totalPending);
return (0, 0, 0, false);
}
converted = true;
uint256 feeConsumed = FullMath.mulDiv(consumed, feePending, totalPending);
uint256 taxConsumed = consumed - feeConsumed;
feeQuoteOut = FullMath.mulDiv(quoteOut, feeConsumed, consumed);
taxQuoteOut = quoteOut - feeQuoteOut;
// The earmark is a marker on part of the fee bucket, so it converts
// at the fee bucket's own fill ratio and then at the rate that bucket
// actually realised. feePending is non-zero whenever the earmark is,
// since the earmark was accrued as a fraction of it.
if (buybackPending != 0) {
uint256 buybackConsumed = FullMath.mulDiv(buybackPending, feeConsumed, feePending);
buybackQuoteOut = feeConsumed == 0 ? 0 : FullMath.mulDiv(feeQuoteOut, buybackConsumed, feeConsumed);
pendingBuyback[poolId][info.memecoin] += buybackPending - buybackConsumed;
}
pendingFees[poolId][info.memecoin] += feePending - feeConsumed;
pendingCreatorTax[poolId][info.memecoin] += taxPending - taxConsumed;
}
/**
* @dev Splits `totalQuote` into protocol / buyback-and-lock / creator,
* running the buyback leg as a real swap of the quote currency back
* into the memecoin before locking the result into the shared
* five-year vest instead of burning it. `taxQuote` bypasses the split
* entirely and is added straight to the creator's payout.
* @param buybackQuote The slice of `totalQuote` earmarked for buyback as
* its fees were charged. Passed in rather than derived here so a toggle
* of the pool's buyback flag cannot reroute value that already accrued.
*/
function _distribute(
PoolId poolId,
LaunchInfo memory info,
uint256 totalQuote,
uint256 taxQuote,
uint256 buybackQuote,
uint256 minBuybackTokensOut
) private {
uint256 protocolAmount = (totalQuote * info.protocolFeeShareBps) / BASIS_POINTS;
uint256 creatorBucket = totalQuote - protocolAmount;
// The earmark was summed per swap, so its rounding can land a wei or
// two above the bucket recomputed here on the aggregate. Clamping
// keeps the subtraction below sound at a full buyback share, where
// the two would otherwise be equal.
uint256 requestedBuyback = buybackQuote < creatorBucket ? buybackQuote : creatorBucket;
uint256 creatorAmount = creatorBucket - requestedBuyback + taxQuote;
uint256 buybackSpent;
uint256 tokensLocked;
if (requestedBuyback != 0) {
if (minBuybackTokensOut == 0) revert MinimumOutputRequired();
(buybackSpent, tokensLocked) = _executeInternalSwap(poolId, SwapDirection.QuoteToMemecoin, requestedBuyback);
// Return the unfilled quote amount to the creator bucket. The
// price limit bounds execution without silently retaining value
// that has already been removed from the creator's accounting.
creatorAmount += requestedBuyback - buybackSpent;
if (tokensLocked != 0) {
IERC20(info.memecoin).forceApprove(address(buybackVault), tokensLocked);
buybackVault.lock(
info.memecoin,
tokensLocked,
info.buybackCreatorRecipient,
info.protocolFeeRecipient,
info.protocolFeeShareBps
);
if (tokensLocked < minBuybackTokensOut) {
revert SlippageExceeded(tokensLocked, minBuybackTokensOut);
}
} else if (buybackSpent == 0) {
// Same rule the curve applies: only a buyback that actually
// executes is subject to the caller's minimum. Enforcing it on
// a buyback that filled nothing would block the creator and
// protocol legs too, stranding the whole distribution over a
// leg that has already been folded back above.
emit PoolBuybackSkipped(poolId, requestedBuyback);
} else {
// Input was consumed but rounded to no output at all. That
// quote is gone into the pool with nothing locked against it,
// so it can be neither folded back nor treated as a skip.
revert SlippageExceeded(0, minBuybackTokensOut);
}
}
_payOut(info.creator, info.quoteToken, creatorAmount);
_payOut(info.protocolFeeRecipient, info.quoteToken, protocolAmount);
emit PoolFeesSwept(poolId, protocolAmount, buybackSpent, creatorAmount, tokensLocked);
}
function _payOut(address recipient, address quoteToken, uint256 amount) private {
if (amount == 0) return;
if (quoteToken == address(0)) {
feeEscrow.credit{value: amount}(recipient);
} else {
uint256 balanceBefore = IERC20(quoteToken).balanceOf(address(feeEscrow));
IERC20(quoteToken).forceApprove(address(feeEscrow), amount);
feeEscrow.creditToken(recipient, quoteToken, amount);
uint256 received = IERC20(quoteToken).balanceOf(address(feeEscrow)) - balanceBefore;
if (received != amount) revert InexactQuoteTransfer(quoteToken, amount, received);
}
}
/**
* @dev Opens a standalone unlock context to run one exact-input internal
* swap, bounded by a price-impact ceiling measured against the pool's
* live price.
*
* That ceiling limits how far this swap moves the price, not where the
* price started. A front-run that depresses spot first shifts the whole
* band down with it, so the bound is slippage control rather than
* manipulation resistance. What actually caps the loss on a sandwich is
* the caller's `minConversionQuoteOut` / `minBuybackTokensOut`, which is
* why every price-sensitive sweep is gated to the sweep operator by
* `_requiresTrustedOperator`. Treat those minimums as the real defense
* and size them off an independent price.
*/
function _executeInternalSwap(PoolId poolId, SwapDirection direction, uint256 amountIn)
private
returns (uint256 amountInConsumed, uint256 amountOut)
{
bytes memory result = poolManager.unlock(abi.encode(poolId, direction, amountIn));
(amountInConsumed, amountOut) = abi.decode(result, (uint256, uint256));
}
function unlockCallback(bytes calldata data) external returns (bytes memory) {
if (msg.sender != address(poolManager)) revert NotPoolManager();
(PoolId poolId, SwapDirection direction, uint256 amountIn) = abi.decode(data, (PoolId, SwapDirection, uint256));
LaunchInfo memory info = launches[poolId];
PoolKey memory key = _poolKeys[poolId];
bool zeroForOne =
direction == SwapDirection.MemecoinToQuote ? info.memecoinIsCurrency0 : !info.memecoinIsCurrency0;
(uint160 sqrtPriceX96,,,) = StateLibrary.getSlot0(poolManager, poolId);
uint160 sqrtPriceLimitX96 = _priceLimit(sqrtPriceX96, zeroForOne, info.maxInternalPriceImpactBps);
BalanceDelta delta = poolManager.swap(
key,
SwapParams({
zeroForOne: zeroForOne,
amountSpecified: -SafeCast.toInt256(amountIn),
sqrtPriceLimitX96: sqrtPriceLimitX96
}),
""
);
_settleCurrency(key.currency0, delta.amount0());
_settleCurrency(key.currency1, delta.amount1());
int128 inputDelta = zeroForOne ? delta.amount0() : delta.amount1();
int128 outputDelta = zeroForOne ? delta.amount1() : delta.amount0();
uint256 amountInConsumed = inputDelta < 0 ? SafeCast.toUint256(-int256(inputDelta)) : 0;
uint256 amountOut = outputDelta > 0 ? SafeCast.toUint256(int256(outputDelta)) : 0;
return abi.encode(amountInConsumed, amountOut);
}
function _settleCurrency(Currency currency, int128 amount) private {
if (amount < 0) {
uint256 owed = uint256(uint128(-amount));
if (currency.isAddressZero()) {
// PoolManager.sync carries no unlock modifier, so the synced-
// currency slot is transient state anyone can leave set for
// the rest of a transaction. Settling native against a stale
// non-zero slot takes the ERC-20 branch and reverts
// NonzeroNativeValue, which v4-core calls out as a DoS vector.
poolManager.sync(currency);
poolManager.settle{value: owed}();
} else {
address token = Currency.unwrap(currency);
uint256 balanceBefore = IERC20(token).balanceOf(address(poolManager));
poolManager.sync(currency);
IERC20(token).safeTransfer(address(poolManager), owed);
uint256 received = IERC20(token).balanceOf(address(poolManager)) - balanceBefore;
if (received != owed) revert InexactQuoteTransfer(token, owed, received);
poolManager.settle();
}
} else if (amount > 0) {
_takeExact(currency, Currency.unwrap(currency), uint256(uint128(amount)));
}
}
/**
* @dev Records only assets that reached the hook in full. Uniswap V4's
* flash accounting requires exact ERC-20 transfers, so transfer-tax quote
* assets fail atomically instead of creating an underfunded fee balance.
*
* On an exact-output swap the fee is charged on the swapper's input leg,
* which the PoolManager has not been paid yet, so this take draws from
* the shared pot and reverts if the fee alone exceeds the PoolManager's
* whole balance of that currency. Reaching that needs an input on the
* order of fifty times the PoolManager's holdings, and the revert falls
* on the swap that caused it. No other pool can lose value to it either,
* since v4's unlock invariant makes the swapper settle the enlarged debt
* before the transaction ends.
*/
function _takeExact(Currency currency, address token, uint256 amount) private {
if (currency.isAddressZero()) {
poolManager.take(currency, address(this), amount);
return;
}
uint256 balanceBefore = IERC20(token).balanceOf(address(this));
poolManager.take(currency, address(this), amount);
uint256 received = IERC20(token).balanceOf(address(this)) - balanceBefore;
if (received != amount) revert InexactQuoteTransfer(token, amount, received);
}
/**
* @dev Bounds the pool's sqrt-price movement for batched internal swaps.
* For a constant-product pool this matches the bonding curve's
* `amountIn / (reserve + amountIn)` reserve-movement bound. The resulting
* spot-price percentage is larger because spot price is proportional to
* sqrtPriceX96 squared; `maxInternalPriceImpactBps` is retained as the
* public policy name for compatibility across both phases.
*/
function _priceLimit(uint160 sqrtPriceX96, bool zeroForOne, uint256 maxPriceImpactBps)
private
pure
returns (uint160)
{
uint256 factor = BASIS_POINTS - maxPriceImpactBps;
if (zeroForOne) {
uint256 limit = (uint256(sqrtPriceX96) * factor) / BASIS_POINTS;
// forge-lint: disable-next-line(unsafe-typecast)
return limit <= TickMath.MIN_SQRT_PRICE ? TickMath.MIN_SQRT_PRICE + 1 : uint160(limit);
} else {
uint256 limit = (uint256(sqrtPriceX96) * BASIS_POINTS) / factor;
// casting to uint160 is safe because this branch only runs when limit < TickMath.MAX_SQRT_PRICE, which is itself < type(uint160).max
// forge-lint: disable-next-line(unsafe-typecast)
return limit >= TickMath.MAX_SQRT_PRICE ? TickMath.MAX_SQRT_PRICE - 1 : uint160(limit);
}
}
/**
* @notice Accepts native ETH pulled out of the pool manager via `take`.
*/
receive() external payable {}
}
contracts/src/v2/PonsV2BuybackVault.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {Ownable2Step} from "@openzeppelin/contracts/access/Ownable2Step.sol";
import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {IPonsV2FeeEscrow, IPonsV2FeePolicy, IPonsV2LaunchFactory} from "./interfaces/ILaunchpadV2.sol";
/**
* @title PonsV2BuybackVault
* @notice Holds every launch's bought-back memecoin supply and releases it
* linearly over five years instead of burning it immediately, splitting
* every release between the creator and the protocol on the launch's
* recorded fee shares. One shared deployment serves every launch, the same
* "single deployment for every token" pattern PonsV2FeeEscrow already uses.
*
* Note that the split applies to the release, not to the funding. Both the
* curve and the hook carve the buyback slice out of the creator's share of
* the fees alone, so the creator funds the entire lock and then receives
* only their fee share of it back. Enabling a buyback therefore moves value
* from the creator to the protocol relative to taking the fees directly,
* by an amount that grows with `buybackBurnBps`.
*
* Deposits use a weighted-average vesting clock instead of per-deposit
* tranches: a launch's fee sweep can add to its lock on every single sweep,
* and tracking an unbounded array of tranches would make `release()`'s gas
* cost grow forever. Instead, each new deposit shifts the launch's single
* `vestingStart` forward by an amount proportional to the deposit's share
* of the new total, so a large existing lock is barely disturbed by a small
* top-up, and a small existing lock is pulled close to the new deposit's own
* clock. `vestedAmount` at any time reflects a fair, size-weighted blend
* across every deposit made so far.
*/
contract PonsV2BuybackVault is Ownable2Step, ReentrancyGuard {
using SafeERC20 for IERC20;
struct LaunchVest {
uint256 totalLocked;
uint256 totalReleased;
uint256 vestingStart;
uint256 vestedUnreleased;
uint256 unvestedAmount;
uint256 lastUpdate;
uint256 vestingEnd;
address creatorRecipient;
address protocolRecipient;
uint16 protocolFeeShareBps;
}
uint256 private constant BASIS_POINTS = 10_000;
uint256 public constant VESTING_DURATION = 5 * 365 days;
error ZeroAddress();
error AlreadyInitialized();
error NotFactory();
error NotAuthorizedLocker();
error NotVestBeneficiary();
error InvalidVestingTerms();
error VestingTermsMismatch();
error OwnershipCannotBeRenounced();
event FactorySet(address factory);
event Locked(address indexed token, address indexed depositor, uint256 amount, uint256 newVestingStart);
event VestingTermsSnapshotted(
address indexed token,
address indexed creatorRecipient,
address indexed protocolRecipient,
uint256 protocolFeeShareBps
);
event Released(address indexed token, uint256 creatorAmount, uint256 protocolAmount);
event CreatorRecipientUpdated(
address indexed token, address indexed previousRecipient, address indexed newRecipient
);
IPonsV2FeePolicy public immutable feePolicy;
IPonsV2FeeEscrow public immutable feeEscrow;
address public factory;
mapping(address token => LaunchVest) private _vaults;
/**
* @param initialOwner Administrative owner; only used to wire the factory once.
* @param feePolicy_ Shared protocol/creator split policy, the same singleton the curve and hook read.
* @param feeEscrow_ Shared claimable balance ledger releases are paid through.
*/
constructor(address initialOwner, IPonsV2FeePolicy feePolicy_, IPonsV2FeeEscrow feeEscrow_) Ownable(initialOwner) {
if (address(feePolicy_) == address(0) || address(feeEscrow_) == address(0)) revert ZeroAddress();
feePolicy = feePolicy_;
feeEscrow = feeEscrow_;
}
/**
* @notice One-time wiring of the v2 factory, set after both are
* deployed, used to authorize each launch's bonding curve as a locker.
*/
function setFactory(address factory_) external onlyOwner {
if (factory != address(0)) revert AlreadyInitialized();
if (factory_ == address(0)) revert ZeroAddress();
factory = factory_;
emit FactorySet(factory_);
}
/**
* @notice Permanently disabled. Ownership here exists only to perform the
* one-time factory wiring, and renouncing before that wiring would strand
* every future buyback lock.
*/
function renounceOwnership() public pure override {
revert OwnershipCannotBeRenounced();
}
/**
* @notice Locks `amount` of `token` into its five-year vest, preserving
* the supplied beneficiaries and split for the active vesting epoch.
* Restricted to the two legitimate callers for `token`'s own buyback:
* the shared meme hook, or `token`'s own bonding curve looked up live
* from the factory.
*/
function lock(
address token,
uint256 amount,
address creatorRecipient,
address protocolRecipient,
uint16 protocolFeeShareBps
) external nonReentrant {
if (token == address(0)) revert ZeroAddress();
if (factory == address(0)) revert NotFactory();
if (!_isAuthorizedLocker(token, msg.sender)) revert NotAuthorizedLocker();
if (amount == 0) return;
if (creatorRecipient == address(0) || protocolRecipient == address(0) || protocolFeeShareBps > BASIS_POINTS) {
revert InvalidVestingTerms();
}
// Schedule against what arrived, not what was asked for. Recording a
// nominal amount the vault never received would make the final
// release of the epoch revert on its own balance, stranding the tail
// of the vest. Every other ERC-20 boundary in the protocol measures
// this delta; this one is no different for being fed by our own
// launcher token today.
uint256 balanceBefore = IERC20(token).balanceOf(address(this));
IERC20(token).safeTransferFrom(msg.sender, address(this), amount);
amount = IERC20(token).balanceOf(address(this)) - balanceBefore;
if (amount == 0) return;
LaunchVest storage v = _vaults[token];
uint256 nowTs = block.timestamp;
_checkpoint(v, nowTs);
_setOrValidateVestingTerms(v, token, creatorRecipient, protocolRecipient, protocolFeeShareBps);
uint256 existingUnvested = v.unvestedAmount;
uint256 combinedAmount = existingUnvested + amount;
uint256 remainingDuration = existingUnvested == 0 ? 0 : v.vestingEnd - nowTs;
uint256 combinedDuration = (existingUnvested * remainingDuration + amount * VESTING_DURATION) / combinedAmount;
v.unvestedAmount = combinedAmount;
v.lastUpdate = nowTs;
v.vestingEnd = nowTs + combinedDuration;
v.vestingStart = nowTs - (VESTING_DURATION - combinedDuration);
v.totalLocked += amount;
emit Locked(token, msg.sender, amount, v.vestingStart);
}
/**
* @notice Releases every currently vested, not-yet-released token for
* `token`, using the beneficiaries and split frozen for its active
* vesting epoch.
* @dev Restricted to the two parties a release pays. Letting anyone
* choose when value leaves the vest is harmful in two ways. A caller can
* time a release inside the protocol owner's creator-recipient recovery
* window, flushing vested tokens to the very address the recovery exists
* to abandon. A caller can also advance the checkpoint every second, so
* each step rounds its newly vested amount down to zero and the vest
* stalls without ever paying out.
*/
function release(address token) external nonReentrant returns (uint256 released) {
if (factory == address(0)) revert NotFactory();
LaunchVest storage v = _vaults[token];
if (msg.sender != v.creatorRecipient && msg.sender != v.protocolRecipient) revert NotVestBeneficiary();
_checkpoint(v, block.timestamp);
released = v.vestedUnreleased;
if (released == 0) return 0;
v.vestedUnreleased = 0;
v.totalReleased += released;
uint256 protocolAmount = (released * v.protocolFeeShareBps) / BASIS_POINTS;
uint256 creatorAmount = released - protocolAmount;
IERC20(token).forceApprove(address(feeEscrow), released);
if (protocolAmount != 0) feeEscrow.creditToken(v.protocolRecipient, token, protocolAmount);
if (creatorAmount != 0) feeEscrow.creditToken(v.creatorRecipient, token, creatorAmount);
emit Released(token, creatorAmount, protocolAmount);
}
/**
* @notice Redirects a launch's buyback vest to a new creator recipient.
* Restricted to the factory, which forwards both self-service creator
* transfers and protocol-owner recovery overrides here, so vested
* buyback tokens track the same recipient as immediate creator fees
* rather than remaining stranded on the launch-time address. Vested but
* not-yet-released tokens follow the new recipient too, matching the
* intent of wallet recovery. Only the protocol split terms stay bound to
* the launch snapshot; the creator identity is managed here instead.
*/
function updateCreatorRecipient(address token, address newRecipient) external {
if (msg.sender != factory) revert NotFactory();
if (token == address(0) || newRecipient == address(0)) revert ZeroAddress();
LaunchVest storage v = _vaults[token];
address previousRecipient = v.creatorRecipient;
if (previousRecipient == newRecipient) return;
v.creatorRecipient = newRecipient;
emit CreatorRecipientUpdated(token, previousRecipient, newRecipient);
}
/**
* @notice Total amount of `token` ever locked into this vault.
*/
function totalLocked(address token) external view returns (uint256) {
return _vaults[token].totalLocked;
}
/**
* @notice Total amount of `token` already released from this vault.
*/
function totalReleased(address token) external view returns (uint256) {
return _vaults[token].totalReleased;
}
/**
* @notice The launch's current weighted-average vesting start time.
* @dev Reporting only. Vesting is accounted from `vestedUnreleased`,
* `unvestedAmount`, `lastUpdate` and `vestingEnd`, which are settled on
* every lock and release. Interpolating this value against
* `VESTING_DURATION` will not reproduce `vestedAmount`, because already
* vested tokens are banked at each deposit rather than recomputed from
* the shifted clock. Read `vestedAmount` for the authoritative figure.
*/
function vestingStart(address token) external view returns (uint256) {
return _vaults[token].vestingStart;
}
/**
* @notice Amount of `token` vested so far, released or not.
*/
function vestedAmount(address token) external view returns (uint256) {
return _vestedAmount(_vaults[token]);
}
/**
* @notice Amount of `token` currently releasable: vested but not yet released.
*/
function releasable(address token) external view returns (uint256) {
LaunchVest storage v = _vaults[token];
return v.vestedUnreleased + _previewNewlyVested(v, block.timestamp);
}
/**
* @notice Returns the immutable terms for the token's active vesting epoch.
*/
function vestingTerms(address token)
external
view
returns (address creatorRecipient, address protocolRecipient, uint16 protocolFeeShareBps)
{
LaunchVest storage v = _vaults[token];
return (v.creatorRecipient, v.protocolRecipient, v.protocolFeeShareBps);
}
/**
* @dev Linear vest over VESTING_DURATION from the launch's current
* weighted-average start time, capped at the total ever locked.
*/
function _vestedAmount(LaunchVest storage v) private view returns (uint256) {
return v.totalReleased + v.vestedUnreleased + _previewNewlyVested(v, block.timestamp);
}
/**
* @dev Crystallizes the linear portion vested since the previous state
* update while preserving the existing schedule's maturity.
*/
function _checkpoint(LaunchVest storage v, uint256 nowTs) private {
uint256 newlyVested = _previewNewlyVested(v, nowTs);
if (newlyVested != 0) {
v.unvestedAmount -= newlyVested;
v.vestedUnreleased += newlyVested;
}
v.lastUpdate = nowTs;
}
/**
* @dev Previews how much of the active schedule vested since lastUpdate.
*/
function _previewNewlyVested(LaunchVest storage v, uint256 nowTs) private view returns (uint256) {
if (v.unvestedAmount == 0 || nowTs <= v.lastUpdate) return 0;
if (nowTs >= v.vestingEnd) return v.unvestedAmount;
uint256 remainingDuration = v.vestingEnd - v.lastUpdate;
uint256 elapsed = nowTs - v.lastUpdate;
return (v.unvestedAmount * elapsed) / remainingDuration;
}
/**
* @dev A new epoch begins only after every token in the prior epoch has
* been released. This keeps every active weighted-average vest bound to
* one immutable set of beneficiaries without unbounded tranche storage.
*/
function _setOrValidateVestingTerms(
LaunchVest storage v,
address token,
address creatorRecipient,
address protocolRecipient,
uint16 protocolFeeShareBps
) private {
bool newEpoch = v.unvestedAmount == 0 && v.vestedUnreleased == 0;
if (newEpoch) {
// Seed the buyback beneficiary only when it has never been set.
// Once the factory has redirected the vest through
// updateCreatorRecipient (a creator transfer or a protocol
// recovery override), a later lock must not silently reset it
// back to the launch-time recipient, even across a fresh epoch.
if (v.creatorRecipient == address(0)) {
v.creatorRecipient = creatorRecipient;
}
v.protocolRecipient = protocolRecipient;
v.protocolFeeShareBps = protocolFeeShareBps;
emit VestingTermsSnapshotted(token, v.creatorRecipient, protocolRecipient, protocolFeeShareBps);
return;
}
// The creator recipient is deliberately excluded from this check: it
// is managed independently through updateCreatorRecipient, so recovery
// can move the vest without ever bricking a subsequent lock on a terms
// mismatch. The protocol split terms remain immutable per launch.
if (v.protocolRecipient != protocolRecipient || v.protocolFeeShareBps != protocolFeeShareBps) {
revert VestingTermsMismatch();
}
}
/**
* @dev The shared meme hook is authorized for every pool it governs
* (it IS `feePolicy`, checked directly). Pre-graduation, `token`'s own
* bonding curve is authorized by looking its address up live from the
* factory's launch record, so no per-launch admin action is ever
* needed to allow a fresh launch's curve to lock its own buybacks.
*/
function _isAuthorizedLocker(address token, address caller) private view returns (bool) {
if (caller == address(feePolicy)) return true;
if (factory == address(0)) return false;
return caller == IPonsV2LaunchFactory(factory).getLaunchedToken(token).curve;
}
}
contracts/lib/v4-core/src/libraries/ProtocolFeeLibrary.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @notice library of functions related to protocol fees
library ProtocolFeeLibrary {
/// @notice Max protocol fee is 0.1% (1000 pips)
/// @dev Increasing these values could lead to overflow in Pool.swap
uint16 public constant MAX_PROTOCOL_FEE = 1000;
/// @notice Thresholds used for optimized bounds checks on protocol fees
uint24 internal constant FEE_0_THRESHOLD = 1001;
uint24 internal constant FEE_1_THRESHOLD = 1001 << 12;
/// @notice the protocol fee is represented in hundredths of a bip
uint256 internal constant PIPS_DENOMINATOR = 1_000_000;
function getZeroForOneFee(uint24 self) internal pure returns (uint16) {
return uint16(self & 0xfff);
}
function getOneForZeroFee(uint24 self) internal pure returns (uint16) {
return uint16(self >> 12);
}
function isValidProtocolFee(uint24 self) internal pure returns (bool valid) {
// Equivalent to: getZeroForOneFee(self) <= MAX_PROTOCOL_FEE && getOneForZeroFee(self) <= MAX_PROTOCOL_FEE
assembly ("memory-safe") {
let isZeroForOneFeeOk := lt(and(self, 0xfff), FEE_0_THRESHOLD)
let isOneForZeroFeeOk := lt(and(self, 0xfff000), FEE_1_THRESHOLD)
valid := and(isZeroForOneFeeOk, isOneForZeroFeeOk)
}
}
// The protocol fee is taken from the input amount first and then the LP fee is taken from the remaining
// The swap fee is capped at 100%
// Equivalent to protocolFee + lpFee(1_000_000 - protocolFee) / 1_000_000 (rounded up)
/// @dev here `self` is just a single direction's protocol fee, not a packed type of 2 protocol fees
function calculateSwapFee(uint16 self, uint24 lpFee) internal pure returns (uint24 swapFee) {
// protocolFee + lpFee - (protocolFee * lpFee / 1_000_000)
assembly ("memory-safe") {
self := and(self, 0xfff)
lpFee := and(lpFee, 0xffffff)
let numerator := mul(self, lpFee)
swapFee := sub(add(self, lpFee), div(numerator, PIPS_DENOMINATOR))
}
}
}
contracts/src/v2/PonsV2GraduationGuard.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {Pool} from "@uniswap/v4-core/src/libraries/Pool.sol";
import {TickMath} from "@uniswap/v4-core/src/libraries/TickMath.sol";
import {LiquidityAmounts} from "@uniswap/v4-periphery/src/libraries/LiquidityAmounts.sol";
import {PonsV2GraduationMath} from "./libraries/PonsV2GraduationMath.sol";
/**
* @title PonsV2GraduationGuard
* @notice Stateless preflight for a graduation's Uniswap V4 seed. It keeps
* the tick and liquidity math outside PonsV2LaunchFactory's runtime bytecode
* while modelling the rejections of the real mint, so a launch can never
* drain its curve into a seed the PositionManager or V4 core would reject.
*
* The preflight has to mirror the whole downstream call graph rather than the
* PositionManager's ABI field widths alone. Phase one is irreversible: it
* marks the curve graduated and moves its reserves to the factory, so a seed
* that passes here and reverts in V4 leaves the launch permanently unseedable
* and recoverable only through the owner's delayed rescue path.
*/
contract PonsV2GraduationGuard {
int24 private constant MIN_USABLE_TICK = -887272;
int24 private constant MAX_USABLE_TICK = 887272;
/**
* @dev V4 carries pool balance changes in a `BalanceDelta` whose halves are
* `int128`, and `Pool.modifyLiquidity` narrows each side with
* `SafeCast.toInt128`. The PositionManager's `MINT_POSITION` ABI accepts
* `uint128`, so an amount in between passes every field-width check and
* still reverts inside V4 core. The signed bound is the real one.
*/
uint256 private constant MAX_SEED_AMOUNT = uint256(uint128(type(int128).max));
error SqrtPriceOutOfBounds();
error GraduationSeedNotViable();
/**
* @notice Verifies a launch can initialize and mint a nonzero, full-range
* V4 position without lossy amount narrowing.
* @param token Launch token being seeded.
* @param pairToken Quote asset of the pool; the zero address for native ETH.
* @param tickSpacing Pool tick spacing the position spans.
* @param quoteAmount Quote-asset side of the seed.
* @param tokenAmount Launch-token side of the seed.
*/
function assertSeedable(
address token,
address pairToken,
int24 tickSpacing,
uint256 quoteAmount,
uint256 tokenAmount
) external pure {
if (token == address(0) || quoteAmount > MAX_SEED_AMOUNT || tokenAmount > MAX_SEED_AMOUNT) {
revert GraduationSeedNotViable();
}
// Native ETH sorts below every ERC-20; two ERC-20s sort by address.
// The seed price is orientation-dependent, so the ordering here must
// match the PoolKey the factory will build.
bool quoteIsCurrency0 = pairToken < token;
(uint256 amount0, uint256 amount1) = quoteIsCurrency0 ? (quoteAmount, tokenAmount) : (tokenAmount, quoteAmount);
_assertSeedable(tickSpacing, amount0, amount1);
}
/**
* @notice Verifies a seed of these proportions mints under either currency
* ordering.
* @dev Launch terms are checked before the launch token exists, so the
* ordering the PoolKey will use is not yet known. Requiring both is the
* conservative reading, and the two agree in practice: the sqrt price
* range is symmetric about 1 and the liquidity formula is invariant under
* inverting the price and swapping the amounts with it.
* @param tickSpacing Pool tick spacing the position spans.
* @param quoteAmount Quote-asset side of the seed.
* @param tokenAmount Launch-token side of the seed.
*/
function assertSeedableEitherOrdering(int24 tickSpacing, uint256 quoteAmount, uint256 tokenAmount) external pure {
if (quoteAmount > MAX_SEED_AMOUNT || tokenAmount > MAX_SEED_AMOUNT) {
revert GraduationSeedNotViable();
}
_assertSeedable(tickSpacing, quoteAmount, tokenAmount);
_assertSeedable(tickSpacing, tokenAmount, quoteAmount);
}
/**
* @dev Models the price and liquidity rejections of the real mint for one
* currency ordering. Amount bounds are the caller's to enforce.
*/
function _assertSeedable(int24 tickSpacing, uint256 amount0, uint256 amount1) private pure {
uint160 sqrtPriceX96 = PonsV2GraduationMath.sqrtPriceX96FromAmounts(amount0, amount1);
if (sqrtPriceX96 <= TickMath.MIN_SQRT_PRICE || sqrtPriceX96 >= TickMath.MAX_SQRT_PRICE) {
revert SqrtPriceOutOfBounds();
}
(int24 tickLower, int24 tickUpper) = _fullRangeTicks(tickSpacing);
uint128 liquidity = LiquidityAmounts.getLiquidityForAmounts(
sqrtPriceX96,
TickMath.getSqrtPriceAtTick(tickLower),
TickMath.getSqrtPriceAtTick(tickUpper),
amount0,
amount1
);
// This mint initializes both boundary ticks, so the position's own
// liquidity is the entire `liquidityGross` at each of them. V4 reverts
// with TickLiquidityOverflow once a tick's gross liquidity passes the
// cap its spacing implies, which is an independent rejection from the
// amount bounds above.
if (liquidity == 0 || liquidity > Pool.tickSpacingToMaxLiquidityPerTick(tickSpacing)) {
revert GraduationSeedNotViable();
}
}
/**
* @dev Derives V4's usable full-range ticks for the configured spacing.
*/
function _fullRangeTicks(int24 tickSpacing) private pure returns (int24 tickLower, int24 tickUpper) {
// Truncation toward zero is required to derive V4's usable boundary ticks.
// forge-lint: disable-next-line(divide-before-multiply)
tickLower = (MIN_USABLE_TICK / tickSpacing) * tickSpacing;
// forge-lint: disable-next-line(divide-before-multiply)
tickUpper = (MAX_USABLE_TICK / tickSpacing) * tickSpacing;
}
}
contracts/lib/openzeppelin-contracts/contracts/utils/LowLevelCall.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.6.0) (utils/LowLevelCall.sol)
pragma solidity ^0.8.20;
/**
* @dev Library of low level call functions that implement different calling strategies to deal with the return data.
*
* WARNING: Using this library requires an advanced understanding of Solidity and how the EVM works. It is recommended
* to use the {Address} library instead.
*/
library LowLevelCall {
/// @dev Performs a Solidity function call using a low level `call` and ignoring the return data.
function callNoReturn(address target, bytes memory data) internal returns (bool success) {
return callNoReturn(target, 0, data);
}
/// @dev Same as {callNoReturn-address-bytes}, but allows specifying the value to be sent in the call.
function callNoReturn(address target, uint256 value, bytes memory data) internal returns (bool success) {
assembly ("memory-safe") {
success := call(gas(), target, value, add(data, 0x20), mload(data), 0x00, 0x00)
}
}
/// @dev Performs a Solidity function call using a low level `call` and returns the first 64 bytes of the result
/// in the scratch space of memory. Useful for functions that return a tuple with two single-word values.
///
/// WARNING: Do not assume that the results are zero if `success` is false. Memory can be already allocated
/// and this function doesn't zero it out.
function callReturn64Bytes(
address target,
bytes memory data
) internal returns (bool success, bytes32 result1, bytes32 result2) {
return callReturn64Bytes(target, 0, data);
}
/// @dev Same as {callReturn64Bytes-address-bytes}, but allows specifying the value to be sent in the call.
function callReturn64Bytes(
address target,
uint256 value,
bytes memory data
) internal returns (bool success, bytes32 result1, bytes32 result2) {
assembly ("memory-safe") {
success := call(gas(), target, value, add(data, 0x20), mload(data), 0x00, 0x40)
result1 := mload(0x00)
result2 := mload(0x20)
}
}
/// @dev Performs a Solidity function call using a low level `staticcall` and ignoring the return data.
function staticcallNoReturn(address target, bytes memory data) internal view returns (bool success) {
assembly ("memory-safe") {
success := staticcall(gas(), target, add(data, 0x20), mload(data), 0x00, 0x00)
}
}
/// @dev Performs a Solidity function call using a low level `staticcall` and returns the first 64 bytes of the result
/// in the scratch space of memory. Useful for functions that return a tuple with two single-word values.
///
/// WARNING: Do not assume that the results are zero if `success` is false. Memory can be already allocated
/// and this function doesn't zero it out.
function staticcallReturn64Bytes(
address target,
bytes memory data
) internal view returns (bool success, bytes32 result1, bytes32 result2) {
assembly ("memory-safe") {
success := staticcall(gas(), target, add(data, 0x20), mload(data), 0x00, 0x40)
result1 := mload(0x00)
result2 := mload(0x20)
}
}
/// @dev Performs a Solidity function call using a low level `delegatecall` and ignoring the return data.
function delegatecallNoReturn(address target, bytes memory data) internal returns (bool success) {
assembly ("memory-safe") {
success := delegatecall(gas(), target, add(data, 0x20), mload(data), 0x00, 0x00)
}
}
/// @dev Performs a Solidity function call using a low level `delegatecall` and returns the first 64 bytes of the result
/// in the scratch space of memory. Useful for functions that return a tuple with two single-word values.
///
/// WARNING: Do not assume that the results are zero if `success` is false. Memory can be already allocated
/// and this function doesn't zero it out.
function delegatecallReturn64Bytes(
address target,
bytes memory data
) internal returns (bool success, bytes32 result1, bytes32 result2) {
assembly ("memory-safe") {
success := delegatecall(gas(), target, add(data, 0x20), mload(data), 0x00, 0x40)
result1 := mload(0x00)
result2 := mload(0x20)
}
}
/// @dev Returns the size of the return data buffer.
function returnDataSize() internal pure returns (uint256 size) {
assembly ("memory-safe") {
size := returndatasize()
}
}
/// @dev Returns a buffer containing the return data from the last call.
function returnData() internal pure returns (bytes memory result) {
assembly ("memory-safe") {
result := mload(0x40)
mstore(result, returndatasize())
returndatacopy(add(result, 0x20), 0x00, returndatasize())
mstore(0x40, add(result, add(0x20, returndatasize())))
}
}
/// @dev Revert with the return data from the last call.
function bubbleRevert() internal pure {
assembly ("memory-safe") {
let fmp := mload(0x40)
returndatacopy(fmp, 0x00, returndatasize())
revert(fmp, returndatasize())
}
}
function bubbleRevert(bytes memory returndata) internal pure {
assembly ("memory-safe") {
revert(add(returndata, 0x20), mload(returndata))
}
}
}
contracts/lib/v4-periphery/src/base/ImmutableState.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
import {IImmutableState} from "../interfaces/IImmutableState.sol";
/// @title Immutable State
/// @notice A collection of immutable state variables, commonly used across multiple contracts
contract ImmutableState is IImmutableState {
/// @inheritdoc IImmutableState
IPoolManager public immutable poolManager;
/// @notice Thrown when the caller is not PoolManager
error NotPoolManager();
/// @notice Only allow calls from the PoolManager contract
modifier onlyPoolManager() {
if (msg.sender != address(poolManager)) revert NotPoolManager();
_;
}
constructor(IPoolManager _poolManager) {
poolManager = _poolManager;
}
}
contracts/src/v2/PonsV2LaunchFactory.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {Ownable2Step} from "@openzeppelin/contracts/access/Ownable2Step.sol";
import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
import {IHooks} from "@uniswap/v4-core/src/interfaces/IHooks.sol";
import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
import {PoolId} from "@uniswap/v4-core/src/types/PoolId.sol";
import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
import {TickMath} from "@uniswap/v4-core/src/libraries/TickMath.sol";
import {FullMath} from "@uniswap/v4-core/src/libraries/FullMath.sol";
import {IPositionManager} from "@uniswap/v4-periphery/src/interfaces/IPositionManager.sol";
import {IAllowanceTransfer} from "permit2/src/interfaces/IAllowanceTransfer.sol";
import {PonsV2LauncherToken} from "./PonsV2LauncherToken.sol";
import {PonsV2BondingCurve} from "./PonsV2BondingCurve.sol";
import {PonsV2BuybackVault} from "./PonsV2BuybackVault.sol";
import {PonsV2LaunchLocker} from "./PonsV2LaunchLocker.sol";
import {PonsV2MemeHook} from "./hooks/PonsV2MemeHook.sol";
import {PonsV2GraduationExecutor} from "./PonsV2GraduationExecutor.sol";
import {LaunchDeployment, PonsV2LaunchDeployer} from "./PonsV2LaunchDeployer.sol";
import {PonsV2GraduationGuard} from "./PonsV2GraduationGuard.sol";
import {PonsV2GraduationMath} from "./libraries/PonsV2GraduationMath.sol";
import {PonsV2BondingCurveMath} from "./libraries/PonsV2BondingCurveMath.sol";
import {
FeePolicySnapshot,
GraduationPhase,
IPonsV2FeeEscrow,
IPonsV2LaunchFactory
} from "./interfaces/ILaunchpadV2.sol";
/**
* @title PonsV2LaunchFactory
* @notice Deploys a bonding curve and its launch token for every pons v2
* launch, then graduates the curve into a permanently locked, full-range
* Uniswap V4 position governed by the shared PonsV2MemeHook.
*
* Each curve already trades in the quote asset its pool will use, so
* graduation never converts between assets and therefore needs no router and
* no price oracle. It stays split into two permissionless phases so a failed
* pool seed cannot strand a curve's reserves:
* - `graduate`: drains the curve's own reserves into this factory. Purely
* internal bookkeeping, so it is safe to call automatically from within
* the crossing buy itself.
* - `createGraduatedPool`: seeds the new V4 pool with those reserves, and
* stays retryable until it succeeds.
*/
contract PonsV2LaunchFactory is Ownable2Step, ReentrancyGuard, IPonsV2LaunchFactory {
using SafeERC20 for IERC20;
uint256 private constant BASIS_POINTS = 10_000;
uint256 private constant MAX_CURVE_FEE_BPS = 1_000; // 10%
uint256 private constant MAX_CREATOR_TAX_CEILING_BPS = 1_000; // 10%
uint256 private constant MAX_TOTAL_TRADE_FEE_BPS = 2_000; // 20%
// Ceiling on the launch-second snipe tax. Held below 100% so a taxed
// buy always nets the buyer something even before the curve applies its
// own combined-fee bound.
uint256 private constant MAX_SNIPE_TAX_START_BPS = 9_900; // 99%
// Ceiling on the snipe tax decay window. Long enough to cover several
// blocks of sniper activity on any chain this deploys to, short enough
// that a misconfiguration cannot leave a launch effectively closed to
// the public for minutes.
uint256 private constant MAX_SNIPE_TAX_SECONDS = 60;
// Bound on the creator-declared exemption list, so a launch cannot be
// made unaffordable to itself by an unbounded loop of exemption writes.
uint256 private constant MAX_SNIPE_TAX_EXEMPTIONS = 32;
uint8 private constant MIN_PAIR_TOKEN_DECIMALS = 6;
// Smallest supply a launch may declare, and the reference supply the
// quotability check assumes when it runs before any config is known.
uint256 private constant MIN_LAUNCH_SUPPLY = 1 ether;
// The quotability check prices a buy of one millionth of the phantom
// reserve. Expressing the reference trade as a fraction of the reserve
// rather than a fixed amount keeps it meaningful across quote assets of
// different decimals, where a wei-denominated constant would be either
// trivial or unreachable.
uint256 private constant REFERENCE_BUY_DIVISOR = 1e6;
// Widest ticks usable at any tick spacing, matching v4-core's own MIN/MAX_TICK.
int24 private constant MIN_USABLE_TICK = -887272;
int24 private constant MAX_USABLE_TICK = 887272;
// Largest tick spacing v4-core's PoolManager will accept; a launch config
// above this would deploy a curve and token but then revert forever at
// pool creation, stranding the swept reserves.
int24 private constant MAX_TICK_SPACING = 32767;
// Largest amount either side of a seed may carry. V4 settles pool balance
// changes through a BalanceDelta of two int128 halves, so the signed
// maximum binds even though the PositionManager's ABI accepts a uint128.
// Mirrors PonsV2GraduationGuard's own ceiling.
uint256 private constant MAX_SEED_AMOUNT = uint256(uint128(type(int128).max));
// Advance notice the protocol owner's creator-fee-recipient override must
// wait out before it can be executed. The creator's own self-service
// transferCreatorFeeRecipient is never subject to this delay.
uint256 public constant CREATOR_FEE_RECIPIENT_TIMELOCK = 3 days;
// How long a launch must sit in Swept before its reserves may be released
// manually. Seeding is permissionless and retryable, so this window is
// what separates a genuinely unseedable launch from one that merely hit a
// transient failure, and it denies the owner a same-block escape hatch.
uint256 public constant GRADUATION_RESCUE_DELAY = 7 days;
// A matured override must execute during this window. Expiration prevents
// an old, forgotten proposal from remaining executable indefinitely.
uint256 public constant CREATOR_FEE_RECIPIENT_EXECUTION_WINDOW = 3 days;
struct TokenParams {
string name;
string symbol;
string logo;
string description;
PonsV2LauncherToken.Socials socials;
address creatorFeeRecipient;
// Additional trade tax the creator charges on top of the launch
// config's base curveFeeBps, capped by maxCreatorTaxBps at launch
// time. Paid entirely to the creator, never split with the protocol.
uint16 creatorTaxBps;
// The creator chooses the initial per-launch buyback-and-lock state.
// Both the current creator recipient and protocol owner may update it.
bool buybackEnabled;
// Optional guard on the economics this launch will lock in. Zero
// waives the check. Set it to the terms quoted at signing time so an
// owner re-peg can never land underneath an in-flight launch.
//
// Call previewLaunchEconomics(launchConfigId, pairToken) to obtain
// this value rather than encoding it by hand. The preimage is
// keccak256(abi.encode(...)) over ten values in this order:
//
// uint256 phantomQuote
// uint256 graduationThreshold
// uint256 config.supply
// uint256 config.curveFeeBps
// uint24 config.poolFee
// int24 config.tickSpacing
// uint16 policy.protocolFeeShareBps
// uint16 policy.buybackBurnBps
// uint16 policy.hookFeeBps
// uint16 policy.maxInternalPriceImpactBps
//
// It spans every owner-controlled term that fixes what the creator is
// buying, not the phantom reserve and threshold alone, so the supply,
// the trade fee or the pool's fee tier cannot move underneath a pin.
bytes32 expectedEconomics;
// CREATE2 salt for the launch's curve and token. The pair's addresses
// are derived from this together with every constructor argument, so
// they can be computed before the launch is sent and cannot be taken
// by a launch that lands first. Namespaced per factory-authenticated
// initiating account, so this only has to be unique among that
// account's own launches; an unused value is all a caller needs, and
// mining it is how a creator chooses a vanity address.
//
// Reusing a value on otherwise identical terms reverts, since the pair
// already exists at that address. Call
// PonsV2LaunchDeployer.predictLaunchAddresses to check in advance.
bytes32 salt;
}
/**
* @notice Native-quote launch economics. `phantomQuote` and
* `graduationThreshold` are in wei here; a launch against an approved
* ERC-20 quote asset takes both from that asset's own PairTokenEconomics
* instead, since neither figure is meaningful across decimals.
*/
struct LaunchConfig {
uint256 supply;
uint256 curveFeeBps;
uint256 phantomQuote;
uint256 graduationThreshold;
uint24 poolFee;
int24 tickSpacing;
bool enabled;
}
/**
* @notice Curve economics for one approved ERC-20 quote asset, in that
* asset's own decimals. Required before the asset may be approved,
* because a wei-denominated phantom reserve applied to a 6-decimal
* stablecoin would misprice the curve by twelve orders of magnitude.
*
* Both figures are sized off chain from a target native-quote value at a
* chosen rate. Scaling the pair by one rate leaves the curve's shape
* untouched, since only threshold / (threshold + phantomQuote) determines
* the fraction of supply that reaches the graduated pool, so a custom
* quote asset trades identically to a native launch of the same size.
*/
struct PairTokenEconomics {
uint256 phantomQuote;
uint256 graduationThreshold;
uint8 decimals;
}
/**
* @notice A protocol-owner-proposed creator-fee-recipient override
* awaiting its timelock, keyed by launch token.
*/
struct PendingCreatorFeeRecipient {
address newRecipient;
uint256 effectiveAt;
uint256 expiresAt;
}
error InvalidLaunchConfigId();
error LaunchConfigDisabled();
error InvalidBasisPoints();
error ExemptionListTooLong();
error InvalidSnipeTaxWindow();
error CurveFeeTooHigh();
error CreatorTaxTooHigh();
error CombinedFeeTooHigh();
error SupplyTooLow();
error InvalidTickSpacing();
error LaunchFeeNotPaid();
error NotWhitelisted();
error FeeTransferFailed();
error ZeroAddress();
error AlreadySet();
error OwnershipCannotBeRenounced();
error InvalidTokenParams();
error TokenNotFound();
error WrongGraduationPhase();
error GraduationStillViable();
error NothingToGraduate();
error SqrtPriceOutOfBounds();
error GraduationExecutorNotSet();
error LaunchDeployerNotSet();
error NotLaunchForwarder();
error NotCreatorFeeRecipient();
error NoPendingChange();
error TimelockNotElapsed(uint256 effectiveAt);
error TimelockExpired(uint256 expiresAt);
error LaunchDependenciesNotWired();
error PairTokenNotApproved();
error PairTokenValidationFailed();
error NotBuybackController();
error CoreLpFeeMustBeZero();
error InvalidGraduationThreshold();
error InvalidPhantomQuote();
error CurveNotQuotable();
error PairTokenEconomicsInvalid();
error PairTokenDecimalsMismatch(uint8 expected, uint8 actual);
error PairTokenDecimalsUnavailable();
error LaunchEconomicsMismatch(bytes32 expected, bytes32 actual);
error InexactTransfer(address token, uint256 expected, uint256 received);
error GraduationSeedNotViable();
error SupplyTooHigh();
error GraduationRescueTooEarly(uint256 availableAt);
event TokenLaunched(
address indexed token,
address indexed curve,
address indexed deployer,
address pairToken,
uint256 launchConfigId,
uint256 graduationThreshold
);
event LaunchSwept(address indexed token, uint256 quoteOut, uint256 tokenOut);
event LaunchForceSwept(address indexed token);
event CreatorFeeRecipientUpdated(
address indexed token, address indexed previousRecipient, address indexed newRecipient
);
event CreatorFeeRecipientChangeProposed(
address indexed token,
address indexed currentRecipient,
address indexed proposedRecipient,
uint256 effectiveAt,
uint256 expiresAt
);
event CreatorFeeRecipientChangeCancelled(address indexed token, address indexed proposedRecipient);
event PoolGraduated(address indexed token, uint256 positionId, uint256 tokenAmount, uint256 pairTokenAmount);
event LaunchConfigAdded(uint256 indexed id);
event LaunchConfigUpdated(uint256 indexed id);
event LaunchFeeUpdated(uint256 launchFee);
event LaunchEnabledUpdated(bool enabled);
event WhitelistedLauncherUpdated(address indexed launcher, bool enabled);
event MaxCreatorTaxUpdated(uint256 bps);
event SnipeTaxStartBpsUpdated(uint256 bps);
event SnipeTaxSecondsUpdated(uint256 secondsWindow);
event GraduationExecutorSet(address executor);
event LaunchDeployerSet(address deployer);
event LaunchForwarderSet(address forwarder);
event PairTokenApprovalUpdated(address indexed pairToken, bool approved);
event PairTokenEconomicsUpdated(
address indexed pairToken, uint256 phantomQuote, uint256 graduationThreshold, uint8 decimals
);
event BuybackEnabledUpdated(address indexed token, bool enabled, address indexed controller);
event GraduationTokensPermanentlyLocked(address indexed token, uint256 amount);
event LaunchGraduationRescued(
address indexed token, address indexed recipient, uint256 quoteAmount, uint256 tokenAmount
);
IPoolManager public immutable poolManager;
IPositionManager public immutable positionManager;
IAllowanceTransfer public immutable permit2;
PonsV2LaunchLocker public immutable locker;
PonsV2MemeHook public immutable memeHook;
IPonsV2FeeEscrow public immutable feeEscrow;
PonsV2BuybackVault public immutable buybackVault;
// Not immutable: each helper's constructor needs this factory's
// already-deployed address, so they are deployed afterward and wired once.
PonsV2GraduationExecutor public graduationExecutor;
PonsV2LaunchDeployer public launchDeployer;
address public launchForwarder;
PonsV2GraduationGuard public immutable graduationGuard;
// Ceiling on the creator-chosen trade tax, mirroring MAX_CURVE_FEE_BPS's
// existing pattern for the protocol's own base fee.
uint256 public maxCreatorTaxBps = 1_000; // 10%
// Anti-snipe tax terms every new launch snapshots at creation: the tax
// charged in the launch second, in basis points of a buy's quote leg,
// and the window across which each curve decays it exponentially to
// zero. Snapshotted rather than read live so retuning here governs
// launches from that moment on while a curve already trading keeps the
// terms it launched under. A zero starting tax disables the mechanism
// for launches created while it is zero.
uint256 public snipeTaxStartBps = 9_900; // 99%
uint256 public snipeTaxSeconds = 15;
uint256 public launchFee;
bool public launchEnabled;
mapping(address launcher => bool enabled) public whitelistedLaunchers;
mapping(address pairToken => bool approved) public approvedPairTokens;
mapping(address pairToken => PairTokenEconomics economics) public pairTokenEconomics;
mapping(address token => FeePolicySnapshot policy) private _launchFeePolicies;
mapping(address token => LaunchedToken launched) private _launchedTokens;
mapping(address token => PendingCreatorFeeRecipient) public pendingCreatorFeeRecipient;
LaunchConfig[] private _launchConfigs;
constructor(
address initialOwner,
IPoolManager poolManager_,
IPositionManager positionManager_,
IAllowanceTransfer permit2_,
PonsV2LaunchLocker locker_,
PonsV2MemeHook memeHook_,
IPonsV2FeeEscrow feeEscrow_,
PonsV2BuybackVault buybackVault_,
uint256 initialLaunchFee
) Ownable(initialOwner) {
if (address(poolManager_) == address(0) || address(positionManager_) == address(0)) {
revert ZeroAddress();
}
if (address(permit2_) == address(0) || address(locker_) == address(0)) revert ZeroAddress();
if (address(memeHook_) == address(0) || address(feeEscrow_) == address(0)) revert ZeroAddress();
if (address(buybackVault_) == address(0)) revert ZeroAddress();
// The factory initializes pools on `poolManager_` but mints their
// liquidity through `positionManager_`. If the two point at different
// singletons every graduation reverts, so the mismatch is caught here
// rather than once per launch: both are immutable, so one check at
// construction covers the contract's whole lifetime.
if (address(positionManager_.poolManager()) != address(poolManager_)) {
revert LaunchDependenciesNotWired();
}
poolManager = poolManager_;
positionManager = positionManager_;
permit2 = permit2_;
locker = locker_;
memeHook = memeHook_;
feeEscrow = feeEscrow_;
buybackVault = buybackVault_;
graduationGuard = new PonsV2GraduationGuard();
launchFee = initialLaunchFee;
}
/**
* @notice Returns the number of launch configurations.
*/
function launchConfigCount() external view returns (uint256) {
return _launchConfigs.length;
}
/**
* @notice Returns one token launch configuration.
*/
function getLaunchConfig(uint256 id) external view returns (LaunchConfig memory) {
if (id >= _launchConfigs.length) revert InvalidLaunchConfigId();
return _launchConfigs[id];
}
/**
* @notice Returns the immutable record for a token created by this factory.
*/
function getLaunchedToken(address token) external view override returns (LaunchedToken memory) {
return _launchedTokens[token];
}
/**
* @notice Returns the fee policy frozen for a launch.
*/
function getLaunchFeePolicy(address token) external view returns (FeePolicySnapshot memory) {
return _launchFeePolicies[token];
}
// ---------------------------------------------------------------------
// Owner-only configuration
// ---------------------------------------------------------------------
/**
* @notice Adds a launch configuration new tokens can be deployed against.
*/
function addLaunchConfig(LaunchConfig calldata config) external onlyOwner returns (uint256 id) {
_validateLaunchConfig(config);
id = _launchConfigs.length;
_launchConfigs.push(config);
emit LaunchConfigAdded(id);
}
/**
* @notice Replaces an existing launch configuration. Already-launched
* tokens are unaffected since their pool parameters were snapshotted.
*/
function updateLaunchConfig(uint256 id, LaunchConfig calldata config) external onlyOwner {
if (id >= _launchConfigs.length) revert InvalidLaunchConfigId();
_validateLaunchConfig(config);
_launchConfigs[id] = config;
emit LaunchConfigUpdated(id);
}
/**
* @notice Changes the fixed native launch fee.
*/
function setLaunchFee(uint256 newLaunchFee) external onlyOwner {
launchFee = newLaunchFee;
emit LaunchFeeUpdated(newLaunchFee);
}
/**
* @notice Opens or closes launches to non-whitelisted callers.
*/
function setLaunchEnabled(bool enabled) external onlyOwner {
launchEnabled = enabled;
emit LaunchEnabledUpdated(enabled);
}
/**
* @notice Grants or revokes permission to launch while the public gate is closed.
*/
function setWhitelistedLauncher(address launcher, bool enabled) external onlyOwner {
if (launcher == address(0)) revert ZeroAddress();
whitelistedLaunchers[launcher] = enabled;
emit WhitelistedLauncherUpdated(launcher, enabled);
}
/**
* @notice Whether `launcher` may launch right now: true while the public
* gate is open, and true for whitelisted addresses while it is closed.
* The same predicate `launchToken` enforces on its caller, exposed so
* routers like PonsV2LaunchAndBuy can hold their own callers to this
* single list instead of maintaining a second one.
*/
function canLaunch(address launcher) public view returns (bool) {
return launchEnabled || whitelistedLaunchers[launcher];
}
/**
* @notice Sets the curve economics a quote asset's launches use, in that
* asset's own decimals. Required before the asset may be approved, and
* updatable afterwards so the peg to a target native-quote value can be
* refreshed as rates move. Existing launches are unaffected: each curve
* receives both figures as constructor immutables, so this only governs
* launches created after it.
* @param expectedDecimals The scale the caller sized both figures against,
* checked against the asset's own report. This is the one guard against
* reusing an 18-decimal configuration on a 6-decimal asset, which would
* otherwise misprice silently by twelve orders of magnitude.
*/
function setPairTokenEconomics(
address pairToken,
uint256 phantomQuote,
uint256 graduationThreshold,
uint8 expectedDecimals
) external onlyOwner {
if (pairToken == address(0) || phantomQuote == 0 || graduationThreshold == 0) {
revert PairTokenEconomicsInvalid();
}
// Curve fees are integer basis points of the quote leg, so on a
// coarse asset every trade below BASIS_POINTS / feeBps base units
// rounds its fee to zero and a trader can split an order into
// fee-free pieces. Six decimals is the floor at which that band is
// dust, and matches the least granular asset worth quoting in.
if (expectedDecimals < MIN_PAIR_TOKEN_DECIMALS) revert PairTokenEconomicsInvalid();
// A launch against this asset takes its phantom reserve from here but
// its supply from whichever config it selects, so the strictest case
// is the smallest supply any config may declare paired with the
// highest fee any of them may charge.
_requireQuotable(phantomQuote, MIN_LAUNCH_SUPPLY, MAX_CURVE_FEE_BPS);
_requireDecimals(pairToken, expectedDecimals, false);
pairTokenEconomics[pairToken] = PairTokenEconomics({
phantomQuote: phantomQuote, graduationThreshold: graduationThreshold, decimals: expectedDecimals
});
emit PairTokenEconomicsUpdated(pairToken, phantomQuote, graduationThreshold, expectedDecimals);
}
/**
* @dev Requires the quote asset to report `expectedDecimals`. Assets with
* no code yet, or that omit the optional metadata call, are accepted on
* the caller's stated scale because nothing contradicts it. The scale is
* stored and re-checked at approval so an address that only becomes a
* contract afterwards cannot enter service on an unverified claim.
*/
function _requireDecimals(address pairToken, uint8 expectedDecimals, bool required) private view {
if (!required && pairToken.code.length == 0) return;
try IERC20Metadata(pairToken).decimals() returns (uint8 actual) {
if (actual != expectedDecimals) revert PairTokenDecimalsMismatch(expectedDecimals, actual);
} catch {
// Sizing may legitimately precede deployment, but an asset whose
// scale cannot be read must never enter service on an unverified
// claim, since the error this guards against is a silent
// twelve-order-of-magnitude mispricing.
if (required) revert PairTokenDecimalsUnavailable();
}
}
/**
* @notice Approves or removes a standard ERC-20 quote asset for new
* launches. Because curves collect the quote asset directly, approving
* one needs nothing beyond a real token contract and the economics its
* curves will price against.
* @dev The stored scale is re-verified here rather than trusted from the
* economics call. Approval is the point where the asset enters service,
* and it is the only point at which the address is guaranteed to hold
* code, so this is what closes the gap for an asset configured before it
* was deployed or one that has since changed its reported decimals.
*/
function setPairTokenApproved(address pairToken, bool approved) external onlyOwner {
if (pairToken == address(0)) revert PairTokenValidationFailed();
if (approved) {
if (pairToken.code.length == 0) revert PairTokenValidationFailed();
PairTokenEconomics memory economics = pairTokenEconomics[pairToken];
if (economics.phantomQuote == 0 || economics.graduationThreshold == 0) {
revert PairTokenEconomicsInvalid();
}
_requireDecimals(pairToken, economics.decimals, true);
}
approvedPairTokens[pairToken] = approved;
emit PairTokenApprovalUpdated(pairToken, approved);
}
/**
* @notice Adjusts the ceiling a creator's chosen trade tax is validated
* against at launch time. Already-launched tokens keep the immutable
* tax rate they launched with regardless of later ceiling changes.
*/
function setMaxCreatorTaxBps(uint256 bps) external onlyOwner {
if (bps > MAX_CREATOR_TAX_CEILING_BPS) revert InvalidBasisPoints();
maxCreatorTaxBps = bps;
emit MaxCreatorTaxUpdated(bps);
}
/**
* @notice Sets the launch-second snipe tax that new launches snapshot
* at creation. Curves already trading keep the figure they launched
* under. Zero disables the tax for launches created while it is zero;
* a nonzero figure must exceed the 20% combined base fee ceiling, so
* the launch-window tax always dominates the ordinary fee take, and
* stays below 100% so a taxed buy always nets the buyer something.
*/
function setSnipeTaxStartBps(uint256 bps) external onlyOwner {
if (bps != 0 && (bps <= MAX_TOTAL_TRADE_FEE_BPS || bps > MAX_SNIPE_TAX_START_BPS)) {
revert InvalidBasisPoints();
}
snipeTaxStartBps = bps;
emit SnipeTaxStartBpsUpdated(bps);
}
/**
* @notice Sets the decay window new launches snapshot at creation, in
* seconds. Capped at one minute so a misconfiguration cannot leave a
* launch effectively closed to the public for minutes; disabling the
* tax is done through `setSnipeTaxStartBps`, so a zero window is
* refused rather than overloaded to mean off.
*/
function setSnipeTaxSeconds(uint256 secondsWindow) external onlyOwner {
if (secondsWindow == 0 || secondsWindow > MAX_SNIPE_TAX_SECONDS) revert InvalidSnipeTaxWindow();
snipeTaxSeconds = secondsWindow;
emit SnipeTaxSecondsUpdated(secondsWindow);
}
/**
* @notice One-time wiring of the graduation executor, set after both are
* deployed since the executor's constructor needs this factory's
* already-known address.
*/
function setGraduationExecutor(PonsV2GraduationExecutor executor) external onlyOwner {
if (address(graduationExecutor) != address(0)) revert AlreadySet();
if (address(executor) == address(0)) revert ZeroAddress();
graduationExecutor = executor;
emit GraduationExecutorSet(address(executor));
}
/**
* @notice One-time wiring of the launch deployer, set after both are
* deployed since the deployer's constructor needs this factory's
* already-known address.
*/
function setLaunchDeployer(PonsV2LaunchDeployer deployer) external onlyOwner {
if (address(launchDeployer) != address(0)) revert AlreadySet();
if (address(deployer) == address(0)) revert ZeroAddress();
launchDeployer = deployer;
emit LaunchDeployerSet(address(deployer));
}
/**
* @notice Sets the router allowed to preserve the initiating user across
* an atomic launch-and-buy call. May be rotated when the router is
* upgraded without replacing the rest of the launch stack.
* @dev Kept separate from `whitelistedLaunchers`: that list controls who
* may launch while the public gate is closed, whereas this address is
* trusted to identify another account for CREATE2 namespacing and launch
* attribution.
*/
function setLaunchForwarder(address forwarder) external onlyOwner {
if (forwarder == address(0)) revert ZeroAddress();
launchForwarder = forwarder;
emit LaunchForwarderSet(forwarder);
}
/**
* @notice Permanently disabled. An ownerless factory could never approve
* a pairToken, adjust fee ceilings, or recover a creator's fee recipient,
* and every launch already live would keep depending on those powers.
* Ownership can still be handed to a new owner via the two-step transfer.
*/
function renounceOwnership() public pure override {
revert OwnershipCannotBeRenounced();
}
// ---------------------------------------------------------------------
// Launch
// ---------------------------------------------------------------------
/**
* @notice Returns the economics digest a launch of `launchConfigId` in
* `pairToken` would produce right now, for a creator to pass back as
* TokenParams.expectedEconomics.
* @dev Reading the digest and launching in separate transactions still
* leaves the terms free to move in between; the pin is what makes that
* movement revert instead of silently repricing the launch.
*/
function previewLaunchEconomics(uint256 launchConfigId, address pairToken) external view returns (bytes32) {
if (launchConfigId >= _launchConfigs.length) revert InvalidLaunchConfigId();
LaunchConfig memory config = _launchConfigs[launchConfigId];
(uint256 phantomQuote, uint256 graduationThreshold) = pairToken == address(0)
? (config.phantomQuote, config.graduationThreshold)
: (pairTokenEconomics[pairToken].phantomQuote, pairTokenEconomics[pairToken].graduationThreshold);
return _economicsDigest(config, memeHook.currentFeePolicy(), phantomQuote, graduationThreshold);
}
/**
* @dev Covers every owner-controlled term that fixes what a creator is
* buying: the curve's shape and cost, the pool the launch graduates into,
* and the fee split that follows it. Narrowing this to the phantom
* reserve and threshold alone would let the supply, the trade fee, or the
* pool's own fee tier move underneath a pinned launch.
*
* maxCreatorTaxBps is intentionally absent. It bounds a figure the
* creator supplies rather than one the protocol sets, so a change makes
* the launch revert on its own rather than silently reprice.
*/
function _economicsDigest(
LaunchConfig memory config,
FeePolicySnapshot memory policy,
uint256 phantomQuote,
uint256 graduationThreshold
) private pure returns (bytes32) {
return keccak256(
abi.encode(
phantomQuote,
graduationThreshold,
config.supply,
config.curveFeeBps,
config.poolFee,
config.tickSpacing,
policy.protocolFeeShareBps,
policy.buybackBurnBps,
policy.hookFeeBps,
policy.maxInternalPriceImpactBps
)
);
}
/**
* @notice Deploys a bonding curve and its launch token, wires them
* together, and records the launch. Trading starts immediately on the
* curve; the graduation pool's pairToken is fixed here, chosen by the
* caller. The caller and their creator fee recipient are exempted from
* the snipe tax automatically; a launch with additional bundle wallets
* should use the overload that takes an exemption list.
*/
function launchToken(TokenParams calldata params, uint256 launchConfigId, address pairToken)
external
payable
nonReentrant
returns (address token, address curve)
{
return _launchToken(params, launchConfigId, pairToken, msg.sender);
}
/**
* @notice Same launch flow, plus a creator-declared list of wallets
* exempted from the snipe tax before trading opens to anyone else. This
* is the sanctioned pathway for organized teams that bundle their
* opening buys across several wallets: declared wallets clear at the
* untaxed price during the launch window while undeclared snipers pay
* the decaying tax.
*/
function launchToken(
TokenParams calldata params,
uint256 launchConfigId,
address pairToken,
address[] calldata snipeTaxExemptions
) external payable nonReentrant returns (address token, address curve) {
(token, curve) = _launchToken(params, launchConfigId, pairToken, msg.sender);
_exemptFromSnipeTax(curve, snipeTaxExemptions);
}
/**
* @notice Launches for the initiating user of the trusted atomic
* launch-and-buy router, with its declared opening-buy exemptions.
* @dev Only the configured `launchForwarder` may supply `originalDeployer`.
* This preserves the real caller without `tx.origin`, which breaks through
* account-abstraction relayers and must never be used for authorization.
*/
function launchTokenFor(
TokenParams calldata params,
uint256 launchConfigId,
address pairToken,
address originalDeployer,
address[] calldata snipeTaxExemptions
) external payable nonReentrant returns (address token, address curve) {
if (msg.sender != launchForwarder) revert NotLaunchForwarder();
(token, curve) = _launchToken(params, launchConfigId, pairToken, originalDeployer);
_exemptFromSnipeTax(curve, snipeTaxExemptions);
}
/**
* @dev Applies the bounded opening-buy exemption list shared by direct and
* forwarded launches.
*/
function _exemptFromSnipeTax(address curve, address[] calldata snipeTaxExemptions) private {
if (snipeTaxExemptions.length > MAX_SNIPE_TAX_EXEMPTIONS) revert ExemptionListTooLong();
for (uint256 i = 0; i < snipeTaxExemptions.length; ++i) {
PonsV2BondingCurve(curve).exemptFromSnipeTax(snipeTaxExemptions[i]);
}
}
/**
* @dev Shared body of the direct and trusted-forwarder entrypoints.
* Validates the launch terms, deploys and records the pair, and exempts
* the creator's own addresses from the snipe tax.
*/
function _launchToken(
TokenParams calldata params,
uint256 launchConfigId,
address pairToken,
address originalDeployer
) private returns (address token, address curve) {
if (address(launchDeployer) == address(0)) revert LaunchDeployerNotSet();
_requireLaunchDependenciesWired();
if (!canLaunch(originalDeployer)) revert NotWhitelisted();
if (msg.value != launchFee) revert LaunchFeeNotPaid();
if (launchConfigId >= _launchConfigs.length) revert InvalidLaunchConfigId();
if (bytes(params.name).length == 0 || bytes(params.symbol).length == 0) revert InvalidTokenParams();
if (params.creatorTaxBps > maxCreatorTaxBps) revert CreatorTaxTooHigh();
if (pairToken != address(0) && !approvedPairTokens[pairToken]) revert PairTokenNotApproved();
LaunchConfig memory config = _launchConfigs[launchConfigId];
FeePolicySnapshot memory policy = memeHook.currentFeePolicy();
// A launch prices in whatever asset it collects, so a custom quote
// asset supplies its own phantom reserve and threshold in its own
// decimals rather than inheriting the config's wei-denominated pair.
(uint256 phantomQuote, uint256 graduationThreshold) = pairToken == address(0)
? (config.phantomQuote, config.graduationThreshold)
: (pairTokenEconomics[pairToken].phantomQuote, pairTokenEconomics[pairToken].graduationThreshold);
// The scale was verified at approval, but an upgradeable quote asset
// can change it afterwards, and this curve prices against the stored
// figure for its entire life. Re-reading here keeps a silent
// twelve-order-of-magnitude mispricing out of the launch.
if (pairToken != address(0)) {
_requireDecimals(pairToken, pairTokenEconomics[pairToken].decimals, true);
}
// Every term below is owner-updatable, so a creator may pin the whole
// set they were quoted rather than accept whatever is current when
// their transaction lands.
bytes32 economics = _economicsDigest(config, policy, phantomQuote, graduationThreshold);
if (params.expectedEconomics != bytes32(0) && params.expectedEconomics != economics) {
revert LaunchEconomicsMismatch(params.expectedEconomics, economics);
}
if (!config.enabled) revert LaunchConfigDisabled();
// Unreachable while the individual ceilings stay where they are, since
// each leg caps at 1000 bps against a 2000 bps combined limit. Kept as
// the check that would actually bind if either ceiling were raised, so
// the combined limit does not depend on arithmetic between constants
// declared far apart.
if (config.curveFeeBps + params.creatorTaxBps > MAX_TOTAL_TRADE_FEE_BPS) {
revert CombinedFeeTooHigh();
}
if (policy.hookFeeBps + params.creatorTaxBps > MAX_TOTAL_TRADE_FEE_BPS) {
revert CombinedFeeTooHigh();
}
// A config and a quote asset are validated separately but graduate as
// a pair, and it is the pair that fixes the seed. Terms that imply a
// position V4 will not mint are refused here, while the creator still
// has their fee and nothing has been deployed.
_requireSeedableTerms(config.supply, phantomQuote, graduationThreshold, config.tickSpacing);
address creatorFeeRecipient =
params.creatorFeeRecipient == address(0) ? originalDeployer : params.creatorFeeRecipient;
(token, curve) = launchDeployer.deployLaunch(
LaunchDeployment({
pairToken: pairToken,
creatorFeeRecipient: creatorFeeRecipient,
originalDeployer: originalDeployer,
feePolicy: memeHook,
policy: policy,
feeEscrow: feeEscrow,
buybackVault: buybackVault,
phantomQuote: phantomQuote,
curveFeeBps: config.curveFeeBps,
creatorTaxBps: params.creatorTaxBps,
buybackEnabled: params.buybackEnabled,
graduationThreshold: graduationThreshold,
supply: config.supply,
salt: params.salt,
name: params.name,
symbol: params.symbol,
logo: params.logo,
description: params.description,
socials: params.socials
})
);
PonsV2BondingCurve(curve).initialize(token);
// The creator's own addresses never count as snipers on their own
// launch: an atomic dev buy lands in the launch second, exactly when
// the tax peaks, and would otherwise be consumed by it.
PonsV2BondingCurve(curve).exemptFromSnipeTax(originalDeployer);
if (creatorFeeRecipient != originalDeployer) {
PonsV2BondingCurve(curve).exemptFromSnipeTax(creatorFeeRecipient);
}
_launchedTokens[token] = LaunchedToken({
token: token,
curve: curve,
deployer: originalDeployer,
creatorFeeRecipient: creatorFeeRecipient,
pairToken: pairToken,
graduationThreshold: graduationThreshold,
poolFee: config.poolFee,
tickSpacing: config.tickSpacing,
creatorTaxBps: params.creatorTaxBps,
buybackEnabled: params.buybackEnabled,
phase: GraduationPhase.NotGraduated,
sweptQuote: 0,
sweptTokens: 0,
sweptAt: 0,
exists: true
});
_launchFeePolicies[token] = policy;
// Last, after the launch is fully recorded: this forwards ETH to the
// protocol recipient, which may be a contract that calls back in.
_payLaunchFee();
emit TokenLaunched(token, curve, originalDeployer, pairToken, launchConfigId, graduationThreshold);
}
// ---------------------------------------------------------------------
// Creator fee recipient
// ---------------------------------------------------------------------
/**
* @notice Lets the current creator fee recipient hand off future creator
* fees for `token` to a new address, whether the launch is still
* trading on its bonding curve or has already graduated into its
* Uniswap V4 pool.
* @dev Does not clear a pending protocol-owner override. If one is
* outstanding, it still executes on schedule and supersedes the address
* set here. See `setCreatorFeeRecipient`.
*/
function transferCreatorFeeRecipient(address token, address newRecipient) external {
LaunchedToken storage launch = _launchedTokens[token];
if (!launch.exists) revert TokenNotFound();
if (msg.sender != launch.creatorFeeRecipient) revert NotCreatorFeeRecipient();
_setCreatorFeeRecipient(token, launch, newRecipient);
}
/**
* @notice Enables or disables buyback-and-lock for one launch. Only the
* current creator recipient may enable it, since the buyback slice is
* funded from the creator's own bucket. The protocol owner may only
* disable it (a strictly creator-favorable action), so the owner can
* never force a creator's fees into the buyback vault to capture the
* protocol's 30% release share against the creator's wishes.
*/
function setBuybackEnabled(address token, bool enabled) external {
LaunchedToken storage launch = _launchedTokens[token];
if (!launch.exists) revert TokenNotFound();
bool isCreator = msg.sender == launch.creatorFeeRecipient;
bool isOwner = msg.sender == owner();
if (!isCreator && !isOwner) revert NotBuybackController();
// Enabling spends the creator's bucket, so only the creator may enable.
if (enabled && !isCreator) revert NotBuybackController();
launch.buybackEnabled = enabled;
if (launch.phase == GraduationPhase.NotGraduated) {
PonsV2BondingCurve(launch.curve).setBuybackEnabled(enabled);
} else if (launch.phase == GraduationPhase.PoolCreated) {
memeHook.setBuybackEnabled(_poolIdFor(token, launch), enabled);
}
emit BuybackEnabledUpdated(token, enabled, msg.sender);
}
/**
* @notice Proposes a protocol-owner override of a launch's creator fee
* recipient. Its motivating case is recovery when a creator loses access
* to their wallet, but the power is deliberately not conditioned on
* that: the owner may redirect the recipient of any launch. Takes effect
* only after `CREATOR_FEE_RECIPIENT_TIMELOCK` has elapsed and someone
* calls `executeCreatorFeeRecipientChange`, giving the community advance
* notice instead of applying instantly. A new proposal for the same
* token replaces any earlier pending one and resets the clock.
*
* @dev A matured proposal takes precedence over any creator transfer made
* while it was pending. `transferCreatorFeeRecipient` deliberately does
* not cancel it, so the timelock is a notice period rather than a window
* in which the creator can veto by moving the recipient themselves. The
* override is therefore a standing protocol power over creator fee
* routing, not a narrowly scoped lost-key recovery, and it is documented
* as such rather than left to whichever call lands last.
*
* The collision is observable without extra state: this function emits
* the recipient as it stood at proposal time, and `_setCreatorFeeRecipient`
* emits the recipient it actually replaced. A creator transfer landing in
* between shows up as a mismatch between the two.
*/
function setCreatorFeeRecipient(address token, address newRecipient) external onlyOwner {
LaunchedToken storage launch = _launchedTokens[token];
if (!launch.exists) revert TokenNotFound();
if (newRecipient == address(0)) revert ZeroAddress();
uint256 effectiveAt = block.timestamp + CREATOR_FEE_RECIPIENT_TIMELOCK;
uint256 expiresAt = effectiveAt + CREATOR_FEE_RECIPIENT_EXECUTION_WINDOW;
pendingCreatorFeeRecipient[token] =
PendingCreatorFeeRecipient({newRecipient: newRecipient, effectiveAt: effectiveAt, expiresAt: expiresAt});
emit CreatorFeeRecipientChangeProposed(token, launch.creatorFeeRecipient, newRecipient, effectiveAt, expiresAt);
}
/**
* @notice Applies a protocol-owner's proposed creator fee recipient
* change once its timelock has elapsed. Permissionless: anyone can
* execute an already-matured proposal.
*/
function executeCreatorFeeRecipientChange(address token) external {
PendingCreatorFeeRecipient memory pending = pendingCreatorFeeRecipient[token];
if (pending.newRecipient == address(0)) revert NoPendingChange();
if (block.timestamp < pending.effectiveAt) revert TimelockNotElapsed(pending.effectiveAt);
if (block.timestamp > pending.expiresAt) revert TimelockExpired(pending.expiresAt);
LaunchedToken storage launch = _launchedTokens[token];
delete pendingCreatorFeeRecipient[token];
_setCreatorFeeRecipient(token, launch, pending.newRecipient);
}
/**
* @notice Cancels a pending protocol-owner override before it takes effect.
*/
function cancelCreatorFeeRecipientChange(address token) external onlyOwner {
if (!_cancelPendingCreatorFeeRecipientChange(token)) revert NoPendingChange();
}
/**
* @dev Updates the factory's own record and forwards the change to
* whichever contract currently pays out creator fees: the bonding curve
* pre-graduation, or the registered meme hook pool afterward.
*/
function _setCreatorFeeRecipient(address token, LaunchedToken storage launch, address newRecipient) private {
if (newRecipient == address(0)) revert ZeroAddress();
address previousRecipient = launch.creatorFeeRecipient;
launch.creatorFeeRecipient = newRecipient;
if (launch.phase == GraduationPhase.PoolCreated) {
memeHook.setCreatorFeeRecipient(_poolIdFor(token, launch), newRecipient);
} else {
PonsV2BondingCurve(launch.curve).setCreatorFeeRecipient(newRecipient);
}
// Keep the buyback vest's beneficiary aligned with the live creator
// recipient so recovery and self-service transfers redirect vested
// buyback tokens as well, not only immediate fee payouts.
buybackVault.updateCreatorRecipient(token, newRecipient);
emit CreatorFeeRecipientUpdated(token, previousRecipient, newRecipient);
}
/**
* @dev Clears a pending protocol override when present.
*/
function _cancelPendingCreatorFeeRecipientChange(address token) private returns (bool cancelled) {
PendingCreatorFeeRecipient memory pending = pendingCreatorFeeRecipient[token];
if (pending.newRecipient == address(0)) return false;
delete pendingCreatorFeeRecipient[token];
emit CreatorFeeRecipientChangeCancelled(token, pending.newRecipient);
return true;
}
/**
* @dev Prevents launches until every singleton and helper points back to
* this factory and to the same core dependencies. A partially wired stack
* could otherwise accept buys but later block fee sweeps or graduation.
*/
function _requireLaunchDependenciesWired() private view {
if (address(graduationExecutor) == address(0)) revert LaunchDependenciesNotWired();
if (launchDeployer.factory() != address(this) || graduationExecutor.factory() != address(this)) {
revert LaunchDependenciesNotWired();
}
if (memeHook.factory() != address(this) || address(memeHook.buybackVault()) != address(buybackVault)) {
revert LaunchDependenciesNotWired();
}
if (buybackVault.factory() != address(this) || locker.factory() != address(this)) {
revert LaunchDependenciesNotWired();
}
if (
address(memeHook.poolManager()) != address(poolManager)
|| address(memeHook.feeEscrow()) != address(feeEscrow)
) {
revert LaunchDependenciesNotWired();
}
if (
address(buybackVault.feePolicy()) != address(memeHook)
|| address(buybackVault.feeEscrow()) != address(feeEscrow)
) {
revert LaunchDependenciesNotWired();
}
if (locker.positionManager() != address(positionManager)) revert LaunchDependenciesNotWired();
if (
address(graduationExecutor.positionManager()) != address(positionManager)
|| address(graduationExecutor.permit2()) != address(permit2)
|| address(graduationExecutor.locker()) != address(locker)
) {
revert LaunchDependenciesNotWired();
}
}
/**
* @dev Reconstructs the pool ID for an already-graduated launch from its
* snapshotted config, since the factory does not separately store it.
*/
function _poolIdFor(address token, LaunchedToken storage launch) private view returns (PoolId) {
(Currency currency0, Currency currency1,) = _sortCurrencies(token, launch.pairToken);
PoolKey memory key = PoolKey({
currency0: currency0,
currency1: currency1,
fee: launch.poolFee,
tickSpacing: launch.tickSpacing,
hooks: IHooks(address(memeHook))
});
return key.toId();
}
// ---------------------------------------------------------------------
// Graduation, phase 1: drain the curve
// ---------------------------------------------------------------------
/**
* @notice Sweeps the curve's remaining quote and token reserves into this
* factory and halts curve trading. Purely internal to the curve's own
* balances, so it is safe for the curve to call this automatically the
* instant a buy crosses the graduation threshold.
*/
function graduate(address token) external nonReentrant {
LaunchedToken storage launch = _launchedTokens[token];
if (!launch.exists) revert TokenNotFound();
if (launch.phase != GraduationPhase.NotGraduated) revert WrongGraduationPhase();
PonsV2BondingCurve curve = PonsV2BondingCurve(launch.curve);
if (!curve.readyToGraduate()) {
revert PonsV2BondingCurve.NotReadyToGraduate();
}
_assertGraduationSeedable(token, launch, curve.realQuoteReserve(), curve.tokenReserve());
_sweepCurve(token, launch, curve);
}
/**
* @notice Sweeps a curve whose seed the preflight refuses, moving its
* reserves into this factory so the delayed rescue path can return them.
* @dev The preflight in `graduate` runs before the irreversible sweep, so
* a launch it refuses stays in NotGraduated. Trading is already closed at
* that point, because the curve shuts its sell side the moment it is ready
* to graduate, and `rescueSweptGraduation` keys off the Swept phase, so
* without this the reserves would have no exit at all. Restricted to
* launches the preflight genuinely refuses: while a seed is still viable
* anyone can call `graduate` and this reverts, so it cannot be used to
* take a healthy launch's reserves in place of seeding its pool. The
* rescue timelock still runs from the sweep recorded here.
*/
function forceSweptGraduation(address token) external onlyOwner nonReentrant {
LaunchedToken storage launch = _launchedTokens[token];
if (!launch.exists) revert TokenNotFound();
if (launch.phase != GraduationPhase.NotGraduated) revert WrongGraduationPhase();
PonsV2BondingCurve curve = PonsV2BondingCurve(launch.curve);
if (!curve.readyToGraduate()) {
revert PonsV2BondingCurve.NotReadyToGraduate();
}
if (_graduationSeedable(token, launch, curve.realQuoteReserve(), curve.tokenReserve())) {
revert GraduationStillViable();
}
_sweepCurve(token, launch, curve);
emit LaunchForceSwept(token);
}
/**
* @dev Moves a ready curve's reserves into this factory and records the
* Swept phase. Shared by the normal graduation path and the forced sweep,
* which differ only in the preflight that precedes them.
*/
function _sweepCurve(address token, LaunchedToken storage launch, PonsV2BondingCurve curve) private {
// Record what this factory actually received rather than what the
// curve reported sending. A quote asset that does not deliver its
// full nominal amount would otherwise leave the launch claiming a
// balance it never got, and the shortfall would be drawn from
// whatever other launches are holding the same asset in escrow here.
uint256 quoteBefore = _quoteBalance(launch.pairToken);
(, uint256 tokenOut) = curve.graduate(address(this));
uint256 quoteOut = _quoteBalance(launch.pairToken) - quoteBefore;
if (quoteOut == 0) revert NothingToGraduate();
launch.sweptQuote = quoteOut;
launch.sweptTokens = tokenOut;
launch.sweptAt = block.timestamp;
launch.phase = GraduationPhase.Swept;
emit LaunchSwept(token, quoteOut, tokenOut);
}
/**
* @dev Whether the seed these reserves imply is one V4 would mint. Mirrors
* `_assertGraduationSeedable` without reverting, so the forced sweep can
* tell a stuck launch from a healthy one. A seed that rounds to nothing is
* reported as unseedable too, since `_poolTokenAmount` refuses it and the
* launch is stuck on that path just the same.
*/
function _graduationSeedable(address token, LaunchedToken storage launch, uint256 sweptQuote, uint256 sweptTokens)
private
view
returns (bool)
{
if (sweptQuote == 0 || sweptTokens == 0) return false;
uint256 virtualQuote = sweptQuote + PonsV2BondingCurve(launch.curve).phantomQuote();
uint256 poolTokenAmount = FullMath.mulDiv(sweptTokens, sweptQuote, virtualQuote);
if (poolTokenAmount == 0) return false;
try graduationGuard.assertSeedable(token, launch.pairToken, launch.tickSpacing, sweptQuote, poolTokenAmount) {
return true;
} catch {
return false;
}
}
/**
* @dev This factory's holding of a launch's quote asset, covering both the
* native and ERC-20 cases so graduation can measure a delta either way.
*/
function _quoteBalance(address pairToken) private view returns (uint256) {
return pairToken == address(0) ? address(this).balance : IERC20(pairToken).balanceOf(address(this));
}
// ---------------------------------------------------------------------
// Graduation, phase 2: seed the V4 pool
// ---------------------------------------------------------------------
/**
* @notice Initializes the V4 pool with the swept reserves, mints a
* full-range position directly to the locker, and registers the pool with
* the meme hook. The curve already holds the pool's quote asset, so this
* seeds with exactly what it swept and needs no slippage bound.
* Permissionless and retryable: a launch stays in Swept until a seed
* succeeds, so a transient failure can never strand reserves.
*/
function createGraduatedPool(address token) external nonReentrant returns (uint256 positionId) {
if (address(graduationExecutor) == address(0)) revert GraduationExecutorNotSet();
LaunchedToken storage launch = _launchedTokens[token];
if (!launch.exists) revert TokenNotFound();
if (launch.phase != GraduationPhase.Swept) revert WrongGraduationPhase();
uint256 sweptQuote = launch.sweptQuote;
_assertGraduationSeedable(token, launch, sweptQuote, launch.sweptTokens);
uint256 tokenAmount = _lockExcessGraduationTokens(token, launch, sweptQuote, launch.sweptTokens);
launch.sweptQuote = 0;
launch.sweptTokens = 0;
launch.sweptAt = 0;
launch.phase = GraduationPhase.PoolCreated;
positionId = _createPoolAndMintPosition(token, launch, tokenAmount, sweptQuote);
emit PoolGraduated(token, positionId, tokenAmount, sweptQuote);
}
/**
* @notice Pays a still-trading launch's pending curve fees directly to the
* protocol and creator recipients, bypassing the escrow, when its quote
* asset has stopped delivering there.
* @dev Also the only way to unwedge such a launch's graduation, since
* `graduate` sweeps fees before handing over the reserves and cannot
* succeed while that sweep reverts. Clearing the buckets makes the sweep
* a no-op and lets graduation proceed.
*/
function rescueCurveFees(address token) external onlyOwner nonReentrant {
LaunchedToken storage launch = _launchedTokens[token];
if (!launch.exists) revert TokenNotFound();
PonsV2BondingCurve(payable(launch.curve)).rescueFees();
}
/**
* @notice Releases a swept launch's reserves to `recipient` when its quote
* asset can no longer satisfy the seed step. `graduate` accepts a quote
* asset that under-delivers, because it credits the balance it actually
* received, but the seed leg funds the executor through `_transferExact`
* and requires the full nominal amount. An asset that becomes
* fee-on-transfer, rebasing, or blocklisting after approval therefore
* leaves a launch that has already halted its curve with a seed step that
* can never succeed, and every holder's quote asset frozen behind it.
*
* Deliberately does not use `_transferExact`: the asset's inability to
* deliver exactly is the reason this path exists, so requiring it here
* would reproduce the failure it recovers from. The reserves are moved
* whole to a single recipient for off-chain distribution rather than
* split on chain, since a launch in this state has no reliable way to pay
* many holders in an asset that cannot pay one.
*
* The owner is trusted here, bounded by GR
contracts/lib/v4-periphery/src/interfaces/IMulticall_v4.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title IMulticall_v4
/// @notice Interface for the Multicall_v4 contract
interface IMulticall_v4 {
/// @notice Call multiple functions in the current contract and return the data from all of them if they all succeed
/// @dev The `msg.value` is passed onto all subcalls, even if a previous subcall has consumed the ether.
/// Subcalls can instead use `address(this).value` to see the available ETH, and consume it using {value: x}.
/// @param data The encoded function data for each of the calls to make to this contract
/// @return results The results from each of the calls passed in via data
function multicall(bytes[] calldata data) external payable returns (bytes[] memory results);
}
contracts/lib/v4-core/src/libraries/BitMath.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title BitMath
/// @dev This library provides functionality for computing bit properties of an unsigned integer
/// @author Solady (https://github.com/Vectorized/solady/blob/8200a70e8dc2a77ecb074fc2e99a2a0d36547522/src/utils/LibBit.sol)
library BitMath {
/// @notice Returns the index of the most significant bit of the number,
/// where the least significant bit is at index 0 and the most significant bit is at index 255
/// @param x the value for which to compute the most significant bit, must be greater than 0
/// @return r the index of the most significant bit
function mostSignificantBit(uint256 x) internal pure returns (uint8 r) {
require(x > 0);
assembly ("memory-safe") {
r := shl(7, lt(0xffffffffffffffffffffffffffffffff, x))
r := or(r, shl(6, lt(0xffffffffffffffff, shr(r, x))))
r := or(r, shl(5, lt(0xffffffff, shr(r, x))))
r := or(r, shl(4, lt(0xffff, shr(r, x))))
r := or(r, shl(3, lt(0xff, shr(r, x))))
// forgefmt: disable-next-item
r := or(r, byte(and(0x1f, shr(shr(r, x), 0x8421084210842108cc6318c6db6d54be)),
0x0706060506020500060203020504000106050205030304010505030400000000))
}
}
/// @notice Returns the index of the least significant bit of the number,
/// where the least significant bit is at index 0 and the most significant bit is at index 255
/// @param x the value for which to compute the least significant bit, must be greater than 0
/// @return r the index of the least significant bit
function leastSignificantBit(uint256 x) internal pure returns (uint8 r) {
require(x > 0);
assembly ("memory-safe") {
// Isolate the least significant bit.
x := and(x, sub(0, x))
// For the upper 3 bits of the result, use a De Bruijn-like lookup.
// Credit to adhusson: https://blog.adhusson.com/cheap-find-first-set-evm/
// forgefmt: disable-next-item
r := shl(5, shr(252, shl(shl(2, shr(250, mul(x,
0xb6db6db6ddddddddd34d34d349249249210842108c6318c639ce739cffffffff))),
0x8040405543005266443200005020610674053026020000107506200176117077)))
// For the lower 5 bits of the result, use a De Bruijn lookup.
// forgefmt: disable-next-item
r := or(r, byte(and(div(0xd76453e0, shr(r, x)), 0x1f),
0x001f0d1e100c1d070f090b19131c1706010e11080a1a141802121b1503160405))
}
}
}
contracts/lib/openzeppelin-contracts/contracts/access/Ownable2Step.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (access/Ownable2Step.sol)
pragma solidity ^0.8.20;
import {Ownable} from "./Ownable.sol";
/**
* @dev Contract module which provides access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* This extension of the {Ownable} contract includes a two-step mechanism to transfer
* ownership, where the new owner must call {acceptOwnership} in order to replace the
* old one. This can help prevent common mistakes, such as transfers of ownership to
* incorrect accounts, or to contracts that are unable to interact with the
* permission system.
*
* The initial owner is specified at deployment time in the constructor for `Ownable`. This
* can later be changed with {transferOwnership} and {acceptOwnership}.
*
* This module is used through inheritance. It will make available all functions
* from parent (Ownable).
*/
abstract contract Ownable2Step is Ownable {
address private _pendingOwner;
event OwnershipTransferStarted(address indexed previousOwner, address indexed newOwner);
/**
* @dev Returns the address of the pending owner.
*/
function pendingOwner() public view virtual returns (address) {
return _pendingOwner;
}
/**
* @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one.
* Can only be called by the current owner.
*
* Setting `newOwner` to the zero address is allowed; this can be used to cancel an initiated ownership transfer.
*/
function transferOwnership(address newOwner) public virtual override onlyOwner {
_pendingOwner = newOwner;
emit OwnershipTransferStarted(owner(), newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`) and deletes any pending owner.
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual override {
delete _pendingOwner;
super._transferOwnership(newOwner);
}
/**
* @dev The new owner accepts the ownership transfer.
*/
function acceptOwnership() public virtual {
address sender = _msgSender();
if (pendingOwner() != sender) {
revert OwnableUnauthorizedAccount(sender);
}
_transferOwnership(sender);
}
}
contracts/lib/v4-core/src/libraries/TickBitmap.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {BitMath} from "./BitMath.sol";
/// @title Packed tick initialized state library
/// @notice Stores a packed mapping of tick index to its initialized state
/// @dev The mapping uses int16 for keys since ticks are represented as int24 and there are 256 (2^8) values per word.
library TickBitmap {
/// @notice Thrown when the tick is not enumerated by the tick spacing
/// @param tick the invalid tick
/// @param tickSpacing The tick spacing of the pool
error TickMisaligned(int24 tick, int24 tickSpacing);
/// @dev round towards negative infinity
function compress(int24 tick, int24 tickSpacing) internal pure returns (int24 compressed) {
// compressed = tick / tickSpacing;
// if (tick < 0 && tick % tickSpacing != 0) compressed--;
assembly ("memory-safe") {
tick := signextend(2, tick)
tickSpacing := signextend(2, tickSpacing)
compressed :=
sub(
sdiv(tick, tickSpacing),
// if (tick < 0 && tick % tickSpacing != 0) then tick % tickSpacing < 0, vice versa
slt(smod(tick, tickSpacing), 0)
)
}
}
/// @notice Computes the position in the mapping where the initialized bit for a tick lives
/// @param tick The tick for which to compute the position
/// @return wordPos The key in the mapping containing the word in which the bit is stored
/// @return bitPos The bit position in the word where the flag is stored
function position(int24 tick) internal pure returns (int16 wordPos, uint8 bitPos) {
assembly ("memory-safe") {
// signed arithmetic shift right
wordPos := sar(8, signextend(2, tick))
bitPos := and(tick, 0xff)
}
}
/// @notice Flips the initialized state for a given tick from false to true, or vice versa
/// @param self The mapping in which to flip the tick
/// @param tick The tick to flip
/// @param tickSpacing The spacing between usable ticks
function flipTick(mapping(int16 => uint256) storage self, int24 tick, int24 tickSpacing) internal {
// Equivalent to the following Solidity:
// if (tick % tickSpacing != 0) revert TickMisaligned(tick, tickSpacing);
// (int16 wordPos, uint8 bitPos) = position(tick / tickSpacing);
// uint256 mask = 1 << bitPos;
// self[wordPos] ^= mask;
assembly ("memory-safe") {
tick := signextend(2, tick)
tickSpacing := signextend(2, tickSpacing)
// ensure that the tick is spaced
if smod(tick, tickSpacing) {
let fmp := mload(0x40)
mstore(fmp, 0xd4d8f3e6) // selector for TickMisaligned(int24,int24)
mstore(add(fmp, 0x20), tick)
mstore(add(fmp, 0x40), tickSpacing)
revert(add(fmp, 0x1c), 0x44)
}
tick := sdiv(tick, tickSpacing)
// calculate the storage slot corresponding to the tick
// wordPos = tick >> 8
mstore(0, sar(8, tick))
mstore(0x20, self.slot)
// the slot of self[wordPos] is keccak256(abi.encode(wordPos, self.slot))
let slot := keccak256(0, 0x40)
// mask = 1 << bitPos = 1 << (tick % 256)
// self[wordPos] ^= mask
sstore(slot, xor(sload(slot), shl(and(tick, 0xff), 1)))
}
}
/// @notice Returns the next initialized tick contained in the same word (or adjacent word) as the tick that is either
/// to the left (less than or equal to) or right (greater than) of the given tick
/// @param self The mapping in which to compute the next initialized tick
/// @param tick The starting tick
/// @param tickSpacing The spacing between usable ticks
/// @param lte Whether to search for the next initialized tick to the left (less than or equal to the starting tick)
/// @return next The next initialized or uninitialized tick up to 256 ticks away from the current tick
/// @return initialized Whether the next tick is initialized, as the function only searches within up to 256 ticks
function nextInitializedTickWithinOneWord(
mapping(int16 => uint256) storage self,
int24 tick,
int24 tickSpacing,
bool lte
) internal view returns (int24 next, bool initialized) {
unchecked {
int24 compressed = compress(tick, tickSpacing);
if (lte) {
(int16 wordPos, uint8 bitPos) = position(compressed);
// all the 1s at or to the right of the current bitPos
uint256 mask = type(uint256).max >> (uint256(type(uint8).max) - bitPos);
uint256 masked = self[wordPos] & mask;
// if there are no initialized ticks to the right of or at the current tick, return rightmost in the word
initialized = masked != 0;
// overflow/underflow is possible, but prevented externally by limiting both tickSpacing and tick
next = initialized
? (compressed - int24(uint24(bitPos - BitMath.mostSignificantBit(masked)))) * tickSpacing
: (compressed - int24(uint24(bitPos))) * tickSpacing;
} else {
// start from the word of the next tick, since the current tick state doesn't matter
(int16 wordPos, uint8 bitPos) = position(++compressed);
// all the 1s at or to the left of the bitPos
uint256 mask = ~((1 << bitPos) - 1);
uint256 masked = self[wordPos] & mask;
// if there are no initialized ticks to the left of the current tick, return leftmost in the word
initialized = masked != 0;
// overflow/underflow is possible, but prevented externally by limiting both tickSpacing and tick
next = initialized
? (compressed + int24(uint24(BitMath.leastSignificantBit(masked) - bitPos))) * tickSpacing
: (compressed + int24(uint24(type(uint8).max - bitPos))) * tickSpacing;
}
}
}
}
contracts/lib/openzeppelin-contracts/contracts/utils/math/SafeCast.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.6.0) (utils/math/SafeCast.sol)
// This file was procedurally generated from scripts/generate/templates/SafeCast.js.
pragma solidity ^0.8.20;
/**
* @dev Wrappers over Solidity's uintXX/intXX/bool casting operators with added overflow
* checks.
*
* Downcasting from uint256/int256 in Solidity does not revert on overflow. This can
* easily result in undesired exploitation or bugs, since developers usually
* assume that overflows raise errors. `SafeCast` restores this intuition by
* reverting the transaction when such an operation overflows.
*
* Using this library instead of the unchecked operations eliminates an entire
* class of bugs, so it's recommended to use it always.
*/
library SafeCast {
/**
* @dev Value doesn't fit in a uint of `bits` size.
*/
error SafeCastOverflowedUintDowncast(uint8 bits, uint256 value);
/**
* @dev An int value doesn't fit in a uint of `bits` size.
*/
error SafeCastOverflowedIntToUint(int256 value);
/**
* @dev Value doesn't fit in an int of `bits` size.
*/
error SafeCastOverflowedIntDowncast(uint8 bits, int256 value);
/**
* @dev A uint value doesn't fit in an int of `bits` size.
*/
error SafeCastOverflowedUintToInt(uint256 value);
/**
* @dev Returns the downcasted uint248 from uint256, reverting on
* overflow (when the input is greater than largest uint248).
*
* Counterpart to Solidity's `uint248` operator.
*
* Requirements:
*
* - input must fit into 248 bits
*/
function toUint248(uint256 value) internal pure returns (uint248) {
if (value > type(uint248).max) {
revert SafeCastOverflowedUintDowncast(248, value);
}
return uint248(value);
}
/**
* @dev Returns the downcasted uint240 from uint256, reverting on
* overflow (when the input is greater than largest uint240).
*
* Counterpart to Solidity's `uint240` operator.
*
* Requirements:
*
* - input must fit into 240 bits
*/
function toUint240(uint256 value) internal pure returns (uint240) {
if (value > type(uint240).max) {
revert SafeCastOverflowedUintDowncast(240, value);
}
return uint240(value);
}
/**
* @dev Returns the downcasted uint232 from uint256, reverting on
* overflow (when the input is greater than largest uint232).
*
* Counterpart to Solidity's `uint232` operator.
*
* Requirements:
*
* - input must fit into 232 bits
*/
function toUint232(uint256 value) internal pure returns (uint232) {
if (value > type(uint232).max) {
revert SafeCastOverflowedUintDowncast(232, value);
}
return uint232(value);
}
/**
* @dev Returns the downcasted uint224 from uint256, reverting on
* overflow (when the input is greater than largest uint224).
*
* Counterpart to Solidity's `uint224` operator.
*
* Requirements:
*
* - input must fit into 224 bits
*/
function toUint224(uint256 value) internal pure returns (uint224) {
if (value > type(uint224).max) {
revert SafeCastOverflowedUintDowncast(224, value);
}
return uint224(value);
}
/**
* @dev Returns the downcasted uint216 from uint256, reverting on
* overflow (when the input is greater than largest uint216).
*
* Counterpart to Solidity's `uint216` operator.
*
* Requirements:
*
* - input must fit into 216 bits
*/
function toUint216(uint256 value) internal pure returns (uint216) {
if (value > type(uint216).max) {
revert SafeCastOverflowedUintDowncast(216, value);
}
return uint216(value);
}
/**
* @dev Returns the downcasted uint208 from uint256, reverting on
* overflow (when the input is greater than largest uint208).
*
* Counterpart to Solidity's `uint208` operator.
*
* Requirements:
*
* - input must fit into 208 bits
*/
function toUint208(uint256 value) internal pure returns (uint208) {
if (value > type(uint208).max) {
revert SafeCastOverflowedUintDowncast(208, value);
}
return uint208(value);
}
/**
* @dev Returns the downcasted uint200 from uint256, reverting on
* overflow (when the input is greater than largest uint200).
*
* Counterpart to Solidity's `uint200` operator.
*
* Requirements:
*
* - input must fit into 200 bits
*/
function toUint200(uint256 value) internal pure returns (uint200) {
if (value > type(uint200).max) {
revert SafeCastOverflowedUintDowncast(200, value);
}
return uint200(value);
}
/**
* @dev Returns the downcasted uint192 from uint256, reverting on
* overflow (when the input is greater than largest uint192).
*
* Counterpart to Solidity's `uint192` operator.
*
* Requirements:
*
* - input must fit into 192 bits
*/
function toUint192(uint256 value) internal pure returns (uint192) {
if (value > type(uint192).max) {
revert SafeCastOverflowedUintDowncast(192, value);
}
return uint192(value);
}
/**
* @dev Returns the downcasted uint184 from uint256, reverting on
* overflow (when the input is greater than largest uint184).
*
* Counterpart to Solidity's `uint184` operator.
*
* Requirements:
*
* - input must fit into 184 bits
*/
function toUint184(uint256 value) internal pure returns (uint184) {
if (value > type(uint184).max) {
revert SafeCastOverflowedUintDowncast(184, value);
}
return uint184(value);
}
/**
* @dev Returns the downcasted uint176 from uint256, reverting on
* overflow (when the input is greater than largest uint176).
*
* Counterpart to Solidity's `uint176` operator.
*
* Requirements:
*
* - input must fit into 176 bits
*/
function toUint176(uint256 value) internal pure returns (uint176) {
if (value > type(uint176).max) {
revert SafeCastOverflowedUintDowncast(176, value);
}
return uint176(value);
}
/**
* @dev Returns the downcasted uint168 from uint256, reverting on
* overflow (when the input is greater than largest uint168).
*
* Counterpart to Solidity's `uint168` operator.
*
* Requirements:
*
* - input must fit into 168 bits
*/
function toUint168(uint256 value) internal pure returns (uint168) {
if (value > type(uint168).max) {
revert SafeCastOverflowedUintDowncast(168, value);
}
return uint168(value);
}
/**
* @dev Returns the downcasted uint160 from uint256, reverting on
* overflow (when the input is greater than largest uint160).
*
* Counterpart to Solidity's `uint160` operator.
*
* Requirements:
*
* - input must fit into 160 bits
*/
function toUint160(uint256 value) internal pure returns (uint160) {
if (value > type(uint160).max) {
revert SafeCastOverflowedUintDowncast(160, value);
}
return uint160(value);
}
/**
* @dev Returns the downcasted uint152 from uint256, reverting on
* overflow (when the input is greater than largest uint152).
*
* Counterpart to Solidity's `uint152` operator.
*
* Requirements:
*
* - input must fit into 152 bits
*/
function toUint152(uint256 value) internal pure returns (uint152) {
if (value > type(uint152).max) {
revert SafeCastOverflowedUintDowncast(152, value);
}
return uint152(value);
}
/**
* @dev Returns the downcasted uint144 from uint256, reverting on
* overflow (when the input is greater than largest uint144).
*
* Counterpart to Solidity's `uint144` operator.
*
* Requirements:
*
* - input must fit into 144 bits
*/
function toUint144(uint256 value) internal pure returns (uint144) {
if (value > type(uint144).max) {
revert SafeCastOverflowedUintDowncast(144, value);
}
return uint144(value);
}
/**
* @dev Returns the downcasted uint136 from uint256, reverting on
* overflow (when the input is greater than largest uint136).
*
* Counterpart to Solidity's `uint136` operator.
*
* Requirements:
*
* - input must fit into 136 bits
*/
function toUint136(uint256 value) internal pure returns (uint136) {
if (value > type(uint136).max) {
revert SafeCastOverflowedUintDowncast(136, value);
}
return uint136(value);
}
/**
* @dev Returns the downcasted uint128 from uint256, reverting on
* overflow (when the input is greater than largest uint128).
*
* Counterpart to Solidity's `uint128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*/
function toUint128(uint256 value) internal pure returns (uint128) {
if (value > type(uint128).max) {
revert SafeCastOverflowedUintDowncast(128, value);
}
return uint128(value);
}
/**
* @dev Returns the downcasted uint120 from uint256, reverting on
* overflow (when the input is greater than largest uint120).
*
* Counterpart to Solidity's `uint120` operator.
*
* Requirements:
*
* - input must fit into 120 bits
*/
function toUint120(uint256 value) internal pure returns (uint120) {
if (value > type(uint120).max) {
revert SafeCastOverflowedUintDowncast(120, value);
}
return uint120(value);
}
/**
* @dev Returns the downcasted uint112 from uint256, reverting on
* overflow (when the input is greater than largest uint112).
*
* Counterpart to Solidity's `uint112` operator.
*
* Requirements:
*
* - input must fit into 112 bits
*/
function toUint112(uint256 value) internal pure returns (uint112) {
if (value > type(uint112).max) {
revert SafeCastOverflowedUintDowncast(112, value);
}
return uint112(value);
}
/**
* @dev Returns the downcasted uint104 from uint256, reverting on
* overflow (when the input is greater than largest uint104).
*
* Counterpart to Solidity's `uint104` operator.
*
* Requirements:
*
* - input must fit into 104 bits
*/
function toUint104(uint256 value) internal pure returns (uint104) {
if (value > type(uint104).max) {
revert SafeCastOverflowedUintDowncast(104, value);
}
return uint104(value);
}
/**
* @dev Returns the downcasted uint96 from uint256, reverting on
* overflow (when the input is greater than largest uint96).
*
* Counterpart to Solidity's `uint96` operator.
*
* Requirements:
*
* - input must fit into 96 bits
*/
function toUint96(uint256 value) internal pure returns (uint96) {
if (value > type(uint96).max) {
revert SafeCastOverflowedUintDowncast(96, value);
}
return uint96(value);
}
/**
* @dev Returns the downcasted uint88 from uint256, reverting on
* overflow (when the input is greater than largest uint88).
*
* Counterpart to Solidity's `uint88` operator.
*
* Requirements:
*
* - input must fit into 88 bits
*/
function toUint88(uint256 value) internal pure returns (uint88) {
if (value > type(uint88).max) {
revert SafeCastOverflowedUintDowncast(88, value);
}
return uint88(value);
}
/**
* @dev Returns the downcasted uint80 from uint256, reverting on
* overflow (when the input is greater than largest uint80).
*
* Counterpart to Solidity's `uint80` operator.
*
* Requirements:
*
* - input must fit into 80 bits
*/
function toUint80(uint256 value) internal pure returns (uint80) {
if (value > type(uint80).max) {
revert SafeCastOverflowedUintDowncast(80, value);
}
return uint80(value);
}
/**
* @dev Returns the downcasted uint72 from uint256, reverting on
* overflow (when the input is greater than largest uint72).
*
* Counterpart to Solidity's `uint72` operator.
*
* Requirements:
*
* - input must fit into 72 bits
*/
function toUint72(uint256 value) internal pure returns (uint72) {
if (value > type(uint72).max) {
revert SafeCastOverflowedUintDowncast(72, value);
}
return uint72(value);
}
/**
* @dev Returns the downcasted uint64 from uint256, reverting on
* overflow (when the input is greater than largest uint64).
*
* Counterpart to Solidity's `uint64` operator.
*
* Requirements:
*
* - input must fit into 64 bits
*/
function toUint64(uint256 value) internal pure returns (uint64) {
if (value > type(uint64).max) {
revert SafeCastOverflowedUintDowncast(64, value);
}
return uint64(value);
}
/**
* @dev Returns the downcasted uint56 from uint256, reverting on
* overflow (when the input is greater than largest uint56).
*
* Counterpart to Solidity's `uint56` operator.
*
* Requirements:
*
* - input must fit into 56 bits
*/
function toUint56(uint256 value) internal pure returns (uint56) {
if (value > type(uint56).max) {
revert SafeCastOverflowedUintDowncast(56, value);
}
return uint56(value);
}
/**
* @dev Returns the downcasted uint48 from uint256, reverting on
* overflow (when the input is greater than largest uint48).
*
* Counterpart to Solidity's `uint48` operator.
*
* Requirements:
*
* - input must fit into 48 bits
*/
function toUint48(uint256 value) internal pure returns (uint48) {
if (value > type(uint48).max) {
revert SafeCastOverflowedUintDowncast(48, value);
}
return uint48(value);
}
/**
* @dev Returns the downcasted uint40 from uint256, reverting on
* overflow (when the input is greater than largest uint40).
*
* Counterpart to Solidity's `uint40` operator.
*
* Requirements:
*
* - input must fit into 40 bits
*/
function toUint40(uint256 value) internal pure returns (uint40) {
if (value > type(uint40).max) {
revert SafeCastOverflowedUintDowncast(40, value);
}
return uint40(value);
}
/**
* @dev Returns the downcasted uint32 from uint256, reverting on
* overflow (when the input is greater than largest uint32).
*
* Counterpart to Solidity's `uint32` operator.
*
* Requirements:
*
* - input must fit into 32 bits
*/
function toUint32(uint256 value) internal pure returns (uint32) {
if (value > type(uint32).max) {
revert SafeCastOverflowedUintDowncast(32, value);
}
return uint32(value);
}
/**
* @dev Returns the downcasted uint24 from uint256, reverting on
* overflow (when the input is greater than largest uint24).
*
* Counterpart to Solidity's `uint24` operator.
*
* Requirements:
*
* - input must fit into 24 bits
*/
function toUint24(uint256 value) internal pure returns (uint24) {
if (value > type(uint24).max) {
revert SafeCastOverflowedUintDowncast(24, value);
}
return uint24(value);
}
/**
* @dev Returns the downcasted uint16 from uint256, reverting on
* overflow (when the input is greater than largest uint16).
*
* Counterpart to Solidity's `uint16` operator.
*
* Requirements:
*
* - input must fit into 16 bits
*/
function toUint16(uint256 value) internal pure returns (uint16) {
if (value > type(uint16).max) {
revert SafeCastOverflowedUintDowncast(16, value);
}
return uint16(value);
}
/**
* @dev Returns the downcasted uint8 from uint256, reverting on
* overflow (when the input is greater than largest uint8).
*
* Counterpart to Solidity's `uint8` operator.
*
* Requirements:
*
* - input must fit into 8 bits
*/
function toUint8(uint256 value) internal pure returns (uint8) {
if (value > type(uint8).max) {
revert SafeCastOverflowedUintDowncast(8, value);
}
return uint8(value);
}
/**
* @dev Converts a signed int256 into an unsigned uint256.
*
* Requirements:
*
* - input must be greater than or equal to 0.
*/
function toUint256(int256 value) internal pure returns (uint256) {
if (value < 0) {
revert SafeCastOverflowedIntToUint(value);
}
return uint256(value);
}
/**
* @dev Returns the downcasted int248 from int256, reverting on
* overflow (when the input is less than smallest int248 or
* greater than largest int248).
*
* Counterpart to Solidity's `int248` operator.
*
* Requirements:
*
* - input must fit into 248 bits
*/
function toInt248(int256 value) internal pure returns (int248 downcasted) {
downcasted = int248(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(248, value);
}
}
/**
* @dev Returns the downcasted int240 from int256, reverting on
* overflow (when the input is less than smallest int240 or
* greater than largest int240).
*
* Counterpart to Solidity's `int240` operator.
*
* Requirements:
*
* - input must fit into 240 bits
*/
function toInt240(int256 value) internal pure returns (int240 downcasted) {
downcasted = int240(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(240, value);
}
}
/**
* @dev Returns the downcasted int232 from int256, reverting on
* overflow (when the input is less than smallest int232 or
* greater than largest int232).
*
* Counterpart to Solidity's `int232` operator.
*
* Requirements:
*
* - input must fit into 232 bits
*/
function toInt232(int256 value) internal pure returns (int232 downcasted) {
downcasted = int232(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(232, value);
}
}
/**
* @dev Returns the downcasted int224 from int256, reverting on
* overflow (when the input is less than smallest int224 or
* greater than largest int224).
*
* Counterpart to Solidity's `int224` operator.
*
* Requirements:
*
* - input must fit into 224 bits
*/
function toInt224(int256 value) internal pure returns (int224 downcasted) {
downcasted = int224(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(224, value);
}
}
/**
* @dev Returns the downcasted int216 from int256, reverting on
* overflow (when the input is less than smallest int216 or
* greater than largest int216).
*
* Counterpart to Solidity's `int216` operator.
*
* Requirements:
*
* - input must fit into 216 bits
*/
function toInt216(int256 value) internal pure returns (int216 downcasted) {
downcasted = int216(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(216, value);
}
}
/**
* @dev Returns the downcasted int208 from int256, reverting on
* overflow (when the input is less than smallest int208 or
* greater than largest int208).
*
* Counterpart to Solidity's `int208` operator.
*
* Requirements:
*
* - input must fit into 208 bits
*/
function toInt208(int256 value) internal pure returns (int208 downcasted) {
downcasted = int208(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(208, value);
}
}
/**
* @dev Returns the downcasted int200 from int256, reverting on
* overflow (when the input is less than smallest int200 or
* greater than largest int200).
*
* Counterpart to Solidity's `int200` operator.
*
* Requirements:
*
* - input must fit into 200 bits
*/
function toInt200(int256 value) internal pure returns (int200 downcasted) {
downcasted = int200(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(200, value);
}
}
/**
* @dev Returns the downcasted int192 from int256, reverting on
* overflow (when the input is less than smallest int192 or
* greater than largest int192).
*
* Counterpart to Solidity's `int192` operator.
*
* Requirements:
*
* - input must fit into 192 bits
*/
function toInt192(int256 value) internal pure returns (int192 downcasted) {
downcasted = int192(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(192, value);
}
}
/**
* @dev Returns the downcasted int184 from int256, reverting on
* overflow (when the input is less than smallest int184 or
* greater than largest int184).
*
* Counterpart to Solidity's `int184` operator.
*
* Requirements:
*
* - input must fit into 184 bits
*/
function toInt184(int256 value) internal pure returns (int184 downcasted) {
downcasted = int184(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(184, value);
}
}
/**
* @dev Returns the downcasted int176 from int256, reverting on
* overflow (when the input is less than smallest int176 or
* greater than largest int176).
*
* Counterpart to Solidity's `int176` operator.
*
* Requirements:
*
* - input must fit into 176 bits
*/
function toInt176(int256 value) internal pure returns (int176 downcasted) {
downcasted = int176(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(176, value);
}
}
/**
* @dev Returns the downcasted int168 from int256, reverting on
* overflow (when the input is less than smallest int168 or
* greater than largest int168).
*
* Counterpart to Solidity's `int168` operator.
*
* Requirements:
*
* - input must fit into 168 bits
*/
function toInt168(int256 value) internal pure returns (int168 downcasted) {
downcasted = int168(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(168, value);
}
}
/**
* @dev Returns the downcasted int160 from int256, reverting on
* overflow (when the input is less than smallest int160 or
* greater than largest int160).
*
* Counterpart to Solidity's `int160` operator.
*
* Requirements:
*
* - input must fit into 160 bits
*/
function toInt160(int256 value) internal pure returns (int160 downcasted) {
downcasted = int160(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(160, value);
}
}
/**
* @dev Returns the downcasted int152 from int256, reverting on
* overflow (when the input is less than smallest int152 or
* greater than largest int152).
*
* Counterpart to Solidity's `int152` operator.
*
* Requirements:
*
* - input must fit into 152 bits
*/
function toInt152(int256 value) internal pure returns (int152 downcasted) {
downcasted = int152(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(152, value);
}
}
/**
* @dev Returns the downcasted int144 from int256, reverting on
* overflow (when the input is less than smallest int144 or
* greater than largest int144).
*
* Counterpart to Solidity's `int144` operator.
*
* Requirements:
*
* - input must fit into 144 bits
*/
function toInt144(int256 value) internal pure returns (int144 downcasted) {
downcasted = int144(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(144, value);
}
}
/**
* @dev Returns the downcasted int136 from int256, reverting on
* overflow (when the input is less than smallest int136 or
* greater than largest int136).
*
* Counterpart to Solidity's `int136` operator.
*
* Requirements:
*
* - input must fit into 136 bits
*/
function toInt136(int256 value) internal pure returns (int136 downcasted) {
downcasted = int136(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(136, value);
}
}
/**
* @dev Returns the downcasted int128 from int256, reverting on
* overflow (when the input is less than smallest int128 or
* greater than largest int128).
*
* Counterpart to Solidity's `int128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*/
function toInt128(int256 value) internal pure returns (int128 downcasted) {
downcasted = int128(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(128, value);
}
}
/**
* @dev Returns the downcasted int120 from int256, reverting on
* overflow (when the input is less than smallest int120 or
* greater than largest int120).
*
* Counterpart to Solidity's `int120` operator.
*
* Requirements:
*
* - input must fit into 120 bits
*/
function toInt120(int256 value) internal pure returns (int120 downcasted) {
downcasted = int120(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(120, value);
}
}
/**
* @dev Returns the downcasted int112 from int256, reverting on
* overflow (when the input is less than smallest int112 or
* greater than largest int112).
*
* Counterpart to Solidity's `int112` operator.
*
* Requirements:
*
* - input must fit into 112 bits
*/
function toInt112(int256 value) internal pure returns (int112 downcasted) {
downcasted = int112(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(112, value);
}
}
/**
* @dev Returns the downcasted int104 from int256, reverting on
* overflow (when the input is less than smallest int104 or
* greater than largest int104).
*
* Counterpart to Solidity's `int104` operator.
*
* Requirements:
*
* - input must fit into 104 bits
*/
function toInt104(int256 value) internal pure returns (int104 downcasted) {
downcasted = int104(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(104, value);
}
}
/**
* @dev Returns the downcasted int96 from int256, reverting on
* overflow (when the input is less than smallest int96 or
* greater than largest int96).
*
* Counterpart to Solidity's `int96` operator.
*
* Requirements:
*
* - input must fit into 96 bits
*/
function toInt96(int256 value) internal pure returns (int96 downcasted) {
downcasted = int96(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(96, value);
}
}
/**
* @dev Returns the downcasted int88 from int256, reverting on
* overflow (when the input is less than smallest int88 or
* greater than largest int88).
*
* Counterpart to Solidity's `int88` operator.
*
* Requirements:
*
* - input must fit into 88 bits
*/
function toInt88(int256 value) internal pure returns (int88 downcasted) {
downcasted = int88(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(88, value);
}
}
/**
* @dev Returns the downcasted int80 from int256, reverting on
* overflow (when the input is less than smallest int80 or
* greater than largest int80).
*
* Counterpart to Solidity's `int80` operator.
*
* Requirements:
*
* - input must fit into 80 bits
*/
function toInt80(int256 value) internal pure returns (int80 downcasted) {
downcasted = int80(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(80, value);
}
}
/**
* @dev Returns the downcasted int72 from int256, reverting on
* overflow (when the input is less than smallest int72 or
* greater than largest int72).
*
* Counterpart to Solidity's `int72` operator.
*
* Requirements:
*
* - input must fit into 72 bits
*/
function toInt72(int256 value) internal pure returns (int72 downcasted) {
downcasted = int72(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(72, value);
}
}
/**
* @dev Returns the downcasted int64 from int256, reverting on
* overflow (when the input is less than smallest int64 or
* greater than largest int64).
*
* Counterpart to Solidity's `int64` operator.
*
* Requirements:
*
* - input must fit into 64 bits
*/
function toInt64(int256 value) internal pure returns (int64 downcasted) {
downcasted = int64(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(64, value);
}
}
/**
* @dev Returns the downcasted int56 from int256, reverting on
* overflow (when the input is less than smallest int56 or
* greater than largest int56).
*
* Counterpart to Solidity's `int56` operator.
*
* Requirements:
*
* - input must fit into 56 bits
*/
function toInt56(int256 value) internal pure returns (int56 downcasted) {
downcasted = int56(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(56, value);
}
}
/**
* @dev Returns the downcasted int48 from int256, reverting on
* overflow (when the input is less than smallest int48 or
* greater than largest int48).
*
* Counterpart to Solidity's `int48` operator.
*
* Requirements:
*
* - input must fit into 48 bits
*/
function toInt48(int256 value) internal pure returns (int48 downcasted) {
downcasted = int48(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(48, value);
}
}
/**
* @dev Returns the downcasted int40 from int256, reverting on
* overflow (when the input is less than smallest int40 or
* greater than largest int40).
*
* Counterpart to Solidity's `int40` operator.
*
* Requirements:
*
* - input must fit into 40 bits
*/
function toInt40(int256 value) internal pure returns (int40 downcasted) {
downcasted = int40(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(40, value);
}
}
/**
* @dev Returns the downcasted int32 from int256, reverting on
* overflow (when the input is less than smallest int32 or
* greater than largest int32).
*
* Counterpart to Solidity's `int32` operator.
*
* Requirements:
*
* - input must fit into 32 bits
*/
function toInt32(int256 value) internal pure returns (int32 downcasted) {
downcasted = int32(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(32, value);
}
}
/**
* @dev Returns the downcasted int24 from int256, reverting on
* overflow (when the input is less than smallest int24 or
* greater than largest int24).
*
* Counterpart to Solidity's `int24` operator.
*
* Requirements:
*
* - input must fit into 24 bits
*/
function toInt24(int256 value) internal pure returns (int24 downcasted) {
downcasted = int24(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(24, value);
}
}
/**
* @dev Returns the downcasted int16 from int256, reverting on
* overflow (when the input is less than smallest int16 or
* greater than largest int16).
*
* Counterpart to Solidity's `int16` operator.
*
* Requirements:
*
* - input must fit into 16 bits
*/
function toInt16(int256 value) internal pure returns (int16 downcasted) {
downcasted = int16(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(16, value);
}
}
/**
* @dev Returns the downcasted int8 from int256, reverting on
* overflow (when the input is less than smallest int8 or
* greater than largest int8).
*
* Counterpart to Solidity's `int8` operator.
*
* Requirements:
*
* - input must fit into 8 bits
*/
function toInt8(int256 value) internal pure returns (int8 downcasted) {
downcasted = int8(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(8, value);
}
}
/**
* @dev Converts an unsigned uint256 into a signed int256.
*
* Requirements:
*
* - input must be less than or equal to maxInt256.
*/
function toInt256(uint256 value) internal pure returns (int256) {
// Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive
if (value > uint256(type(int256).max)) {
revert SafeCastOverflowedUintToInt(value);
}
return int256(value);
}
/**
* @dev Cast a boolean (false or true) to a uint256 (0 or 1) with no jump.
*/
function toUint(bool b) internal pure returns (uint256 u) {
assembly ("memory-safe") {
u := iszero(iszero(b))
}
}
}
contracts/src/v2/PonsV2LaunchLocker.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {Ownable2Step} from "@openzeppelin/contracts/access/Ownable2Step.sol";
import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {IERC721ReceiverLike} from "./interfaces/ILaunchpadV2.sol";
/**
* @title PonsV2LaunchLocker
* @notice Permanently holds the graduated Uniswap V4 position NFT for every
* pons v2 launch. Unlike v1's locker, there is no `collectFees()` here: fee
* collection and distribution belong entirely to PonsV2MemeHook and
* PonsV2FeeEscrow, since a V4 position accrues fees inside the singleton
* PoolManager rather than on the NFT itself. This contract exposes no
* withdrawal or arbitrary-call function, so locked liquidity can never be
* removed by an administrator.
*/
contract PonsV2LaunchLocker is Ownable2Step, IERC721ReceiverLike {
using SafeERC20 for IERC20;
error NotFactory();
error AlreadyInitialized();
error ZeroAddress();
error PositionAlreadyLocked();
error PositionNotHeld();
error NotPositionManager();
error OwnershipCannotBeRenounced();
event FactorySet(address factory);
event PositionLocked(address indexed token, uint256 indexed tokenId);
event TokenSupplyLocked(address indexed token, uint256 amount);
address public immutable positionManager;
address public factory;
mapping(address token => uint256 tokenId) public lockedPositions;
mapping(address token => uint256 amount) public lockedTokenSupply;
mapping(address token => bool locked) private _locked;
/**
* @param initialOwner Administrative owner; only used to wire the factory once.
* @param positionManager_ The canonical Uniswap V4 PositionManager for this chain.
*/
constructor(address initialOwner, address positionManager_) Ownable(initialOwner) {
if (positionManager_ == address(0)) revert ZeroAddress();
positionManager = positionManager_;
}
modifier onlyFactory() {
if (msg.sender != factory) revert NotFactory();
_;
}
/**
* @notice One-time wiring of the v2 factory, set after both are deployed.
*/
function setFactory(address factory_) external onlyOwner {
if (factory != address(0)) revert AlreadyInitialized();
if (factory_ == address(0)) revert ZeroAddress();
factory = factory_;
emit FactorySet(factory_);
}
/**
* @notice Permanently disabled. Ownership here exists only to perform the
* one-time factory wiring, and renouncing before that wiring would leave
* the locker unable to ever accept a graduated position.
*/
function renounceOwnership() public pure override {
revert OwnershipCannotBeRenounced();
}
/**
* @notice Rejects safe transfers of anything but a canonical position NFT.
* @dev Not part of the graduation path. Graduation names this locker as
* the `MINT_POSITION` owner, and the PositionManager mints with a plain
* `_mint`, which fires no receiver callback. Custody is established by
* the `ownerOf` check in `lockPosition` instead. This exists so the
* locker still behaves correctly under an explicit `safeTransferFrom`,
* and so such a transfer can only ever originate from the canonical
* PositionManager.
*/
function onERC721Received(address, address, uint256, bytes calldata) external view returns (bytes4) {
if (msg.sender != positionManager) revert NotPositionManager();
return IERC721ReceiverLike.onERC721Received.selector;
}
/**
* @notice Registers and verifies permanent custody of a graduated position.
* @dev Called once per launch by the factory, immediately after minting
* the full-range position directly to this locker's address.
*/
function lockPosition(address token, uint256 tokenId) external onlyFactory {
if (_locked[token]) revert PositionAlreadyLocked();
if (IERC721(positionManager).ownerOf(tokenId) != address(this)) revert PositionNotHeld();
_locked[token] = true;
lockedPositions[token] = tokenId;
emit PositionLocked(token, tokenId);
}
/**
* @notice Permanently locks the virtual-reserve token remainder that
* cannot enter the graduated pool without lowering its opening price.
*/
function lockTokenSupply(address token, uint256 amount) external onlyFactory {
if (token == address(0)) revert ZeroAddress();
if (amount == 0) return;
IERC20(token).safeTransferFrom(msg.sender, address(this), amount);
lockedTokenSupply[token] += amount;
emit TokenSupplyLocked(token, amount);
}
/**
* @notice Returns whether a launch's position has been locked here.
*/
function isLocked(address token) external view returns (bool) {
return _locked[token];
}
}
contracts/lib/v4-core/src/libraries/SwapMath.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {FullMath} from "./FullMath.sol";
import {SqrtPriceMath} from "./SqrtPriceMath.sol";
/// @title Computes the result of a swap within ticks
/// @notice Contains methods for computing the result of a swap within a single tick price range, i.e., a single tick.
library SwapMath {
/// @notice the swap fee is represented in hundredths of a bip, so the max is 100%
/// @dev the swap fee is the total fee on a swap, including both LP and Protocol fee
uint256 internal constant MAX_SWAP_FEE = 1e6;
/// @notice Computes the sqrt price target for the next swap step
/// @param zeroForOne The direction of the swap, true for currency0 to currency1, false for currency1 to currency0
/// @param sqrtPriceNextX96 The Q64.96 sqrt price for the next initialized tick
/// @param sqrtPriceLimitX96 The Q64.96 sqrt price limit. If zero for one, the price cannot be less than this value
/// after the swap. If one for zero, the price cannot be greater than this value after the swap
/// @return sqrtPriceTargetX96 The price target for the next swap step
function getSqrtPriceTarget(bool zeroForOne, uint160 sqrtPriceNextX96, uint160 sqrtPriceLimitX96)
internal
pure
returns (uint160 sqrtPriceTargetX96)
{
assembly ("memory-safe") {
// a flag to toggle between sqrtPriceNextX96 and sqrtPriceLimitX96
// when zeroForOne == true, nextOrLimit reduces to sqrtPriceNextX96 >= sqrtPriceLimitX96
// sqrtPriceTargetX96 = max(sqrtPriceNextX96, sqrtPriceLimitX96)
// when zeroForOne == false, nextOrLimit reduces to sqrtPriceNextX96 < sqrtPriceLimitX96
// sqrtPriceTargetX96 = min(sqrtPriceNextX96, sqrtPriceLimitX96)
sqrtPriceNextX96 := and(sqrtPriceNextX96, 0xffffffffffffffffffffffffffffffffffffffff)
sqrtPriceLimitX96 := and(sqrtPriceLimitX96, 0xffffffffffffffffffffffffffffffffffffffff)
let nextOrLimit := xor(lt(sqrtPriceNextX96, sqrtPriceLimitX96), and(zeroForOne, 0x1))
let symDiff := xor(sqrtPriceNextX96, sqrtPriceLimitX96)
sqrtPriceTargetX96 := xor(sqrtPriceLimitX96, mul(symDiff, nextOrLimit))
}
}
/// @notice Computes the result of swapping some amount in, or amount out, given the parameters of the swap
/// @dev If the swap's amountSpecified is negative, the combined fee and input amount will never exceed the absolute value of the remaining amount.
/// @param sqrtPriceCurrentX96 The current sqrt price of the pool
/// @param sqrtPriceTargetX96 The price that cannot be exceeded, from which the direction of the swap is inferred
/// @param liquidity The usable liquidity
/// @param amountRemaining How much input or output amount is remaining to be swapped in/out
/// @param feePips The fee taken from the input amount, expressed in hundredths of a bip
/// @return sqrtPriceNextX96 The price after swapping the amount in/out, not to exceed the price target
/// @return amountIn The amount to be swapped in, of either currency0 or currency1, based on the direction of the swap
/// @return amountOut The amount to be received, of either currency0 or currency1, based on the direction of the swap
/// @return feeAmount The amount of input that will be taken as a fee
/// @dev feePips must be no larger than MAX_SWAP_FEE for this function. We ensure that before setting a fee using LPFeeLibrary.isValid.
function computeSwapStep(
uint160 sqrtPriceCurrentX96,
uint160 sqrtPriceTargetX96,
uint128 liquidity,
int256 amountRemaining,
uint24 feePips
) internal pure returns (uint160 sqrtPriceNextX96, uint256 amountIn, uint256 amountOut, uint256 feeAmount) {
unchecked {
uint256 _feePips = feePips; // upcast once and cache
bool zeroForOne = sqrtPriceCurrentX96 >= sqrtPriceTargetX96;
bool exactIn = amountRemaining < 0;
if (exactIn) {
uint256 amountRemainingLessFee =
FullMath.mulDiv(uint256(-amountRemaining), MAX_SWAP_FEE - _feePips, MAX_SWAP_FEE);
amountIn = zeroForOne
? SqrtPriceMath.getAmount0Delta(sqrtPriceTargetX96, sqrtPriceCurrentX96, liquidity, true)
: SqrtPriceMath.getAmount1Delta(sqrtPriceCurrentX96, sqrtPriceTargetX96, liquidity, true);
if (amountRemainingLessFee >= amountIn) {
// `amountIn` is capped by the target price
sqrtPriceNextX96 = sqrtPriceTargetX96;
feeAmount = _feePips == MAX_SWAP_FEE
? amountIn // amountIn is always 0 here, as amountRemainingLessFee == 0 and amountRemainingLessFee >= amountIn
: FullMath.mulDivRoundingUp(amountIn, _feePips, MAX_SWAP_FEE - _feePips);
} else {
// exhaust the remaining amount
amountIn = amountRemainingLessFee;
sqrtPriceNextX96 = SqrtPriceMath.getNextSqrtPriceFromInput(
sqrtPriceCurrentX96, liquidity, amountRemainingLessFee, zeroForOne
);
// we didn't reach the target, so take the remainder of the maximum input as fee
feeAmount = uint256(-amountRemaining) - amountIn;
}
amountOut = zeroForOne
? SqrtPriceMath.getAmount1Delta(sqrtPriceNextX96, sqrtPriceCurrentX96, liquidity, false)
: SqrtPriceMath.getAmount0Delta(sqrtPriceCurrentX96, sqrtPriceNextX96, liquidity, false);
} else {
amountOut = zeroForOne
? SqrtPriceMath.getAmount1Delta(sqrtPriceTargetX96, sqrtPriceCurrentX96, liquidity, false)
: SqrtPriceMath.getAmount0Delta(sqrtPriceCurrentX96, sqrtPriceTargetX96, liquidity, false);
if (uint256(amountRemaining) >= amountOut) {
// `amountOut` is capped by the target price
sqrtPriceNextX96 = sqrtPriceTargetX96;
} else {
// cap the output amount to not exceed the remaining output amount
amountOut = uint256(amountRemaining);
sqrtPriceNextX96 =
SqrtPriceMath.getNextSqrtPriceFromOutput(sqrtPriceCurrentX96, liquidity, amountOut, zeroForOne);
}
amountIn = zeroForOne
? SqrtPriceMath.getAmount0Delta(sqrtPriceNextX96, sqrtPriceCurrentX96, liquidity, true)
: SqrtPriceMath.getAmount1Delta(sqrtPriceCurrentX96, sqrtPriceNextX96, liquidity, true);
// `feePips` cannot be `MAX_SWAP_FEE` for exact out
feeAmount = FullMath.mulDivRoundingUp(amountIn, _feePips, MAX_SWAP_FEE - _feePips);
}
}
}
}
contracts/lib/openzeppelin-contracts/contracts/utils/Context.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}
contracts/lib/v4-core/src/types/PoolId.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {PoolKey} from "./PoolKey.sol";
type PoolId is bytes32;
/// @notice Library for computing the ID of a pool
library PoolIdLibrary {
/// @notice Returns value equal to keccak256(abi.encode(poolKey))
function toId(PoolKey memory poolKey) internal pure returns (PoolId poolId) {
assembly ("memory-safe") {
// 0xa0 represents the total size of the poolKey struct (5 slots of 32 bytes)
poolId := keccak256(poolKey, 0xa0)
}
}
}
contracts/lib/openzeppelin-contracts/contracts/token/ERC721/IERC721.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/IERC721.sol)
pragma solidity >=0.6.2;
import {IERC165} from "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC-721 compliant contract.
*/
interface IERC721 is IERC165 {
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/
function balanceOf(address owner) external view returns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function ownerOf(uint256 tokenId) external view returns (address owner);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
* a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId, bytes calldata data) external;
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC-721 protocol to prevent tokens from being forever locked.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must have been allowed to move this token by either {approve} or
* {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
* a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC-721
* or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
* understand this adds an external call which potentially creates a reentrancy vulnerability.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Gives permission to `to` to transfer `tokenId` token to another account.
* The approval is cleared when the token is transferred.
*
* Only a single account can be approved at a time, so approving the zero address clears previous approvals.
*
* Requirements:
*
* - The caller must own the token or be an approved operator.
* - `tokenId` must exist.
*
* Emits an {Approval} event.
*/
function approve(address to, uint256 tokenId) external;
/**
* @dev Approve or remove `operator` as an operator for the caller.
* Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
*
* Requirements:
*
* - The `operator` cannot be the address zero.
*
* Emits an {ApprovalForAll} event.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function getApproved(uint256 tokenId) external view returns (address operator);
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/
function isApprovedForAll(address owner, address operator) external view returns (bool);
}
contracts/src/v2/PonsV2BondingCurve.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {PonsV2BondingCurveMath} from "./libraries/PonsV2BondingCurveMath.sol";
import {PonsV2BuybackVault} from "./PonsV2BuybackVault.sol";
import {PonsV2LauncherToken} from "./PonsV2LauncherToken.sol";
import {FeePolicySnapshot, IPonsV2FeeEscrow, IPonsV2FeePolicy, IPonsV2SnipeTax} from "./interfaces/ILaunchpadV2.sol";
import {IPonsV2LaunchFactoryGraduation} from "./interfaces/ILaunchpadV2Graduation.sol";
/**
* @title PonsV2BondingCurve
* @notice Constant-product bonding curve for one v2 launch, adapted from
* BootstrapPool.sol (code-423n4/2025-01-iq-ai). The curve trades against the
* same quote asset its graduated Uniswap V4 pool will use: native ETH when
* `pairToken` is the zero address, otherwise that ERC-20. Collecting the
* eventual pool asset from the very first trade is what lets graduation seed
* the pool directly, with no swap and therefore no price oracle anywhere in
* the system.
*
* Every trade fee is charged against the quote leg regardless of trade
* direction, so the curve never accrues fees denominated in the memecoin:
* protocol and creator revenue is quote-denominated from the first trade,
* before graduation ever happens. Fees are split and swept through the same
* protocol/creator/buyback-and-lock policy the post-graduation hook uses,
* read from `feePolicy` so both phases behave identically.
*/
contract PonsV2BondingCurve is ReentrancyGuard {
using SafeERC20 for IERC20;
uint256 private constant BASIS_POINTS = 10_000;
uint256 private constant MAX_TOTAL_TRADE_FEE_BPS = 2_000; // 20%
error CurveGraduated();
error ZeroAmount();
error ZeroAddress();
error SlippageExceeded(uint256 actual, uint256 minimum);
error NotFactory();
error TransferFailed();
error AlreadyGraduated();
error AlreadyInitialized();
error NotInitialized();
error InvalidLaunchEconomics();
error NotReadyToGraduate();
error NotFeeSweepOperator();
error InternalSwapRequiresOperator();
error InvalidFeePolicy();
error MinimumOutputRequired();
error NativeValueMismatch(uint256 supplied, uint256 expected);
error UnexpectedNativeValue();
// `fee` and `tax` are reported separately because they fund different
// parties: the fee splits across protocol, buyback and creator, while the
// tax is paid to the creator in full.
event CurveBuy(
address indexed buyer, address indexed recipient, uint256 quoteIn, uint256 tokensOut, uint256 fee, uint256 tax
);
event CurveBuyRefunded(address indexed buyer, uint256 refund);
event CurveSell(
address indexed seller, address indexed recipient, uint256 tokensIn, uint256 quoteOut, uint256 fee, uint256 tax
);
event FeesSwept(uint256 protocolAmount, uint256 buybackAmount, uint256 creatorAmount);
event FeesRescued(
address indexed protocolRecipient,
address indexed creatorRecipient,
uint256 protocolAmount,
uint256 creatorAmount
);
event BuybackLocked(uint256 quoteSpent, uint256 tokensLocked);
event CurveCompleted(address recipient, uint256 quoteOut, uint256 tokenOut);
event Initialized(address token);
event CreatorFeeRecipientUpdated(address indexed previousRecipient, address indexed newRecipient);
event BuybackEnabledUpdated(bool enabled);
event AutoGraduationFailed(address indexed token, uint256 gasRemaining);
event SnipeTaxExempted(address indexed account);
// Separate from CurveBuy so indexers can tell an ordinary fee from a
// launch-window penalty and surface which wallets sniped the launch.
event SnipeTaxCharged(address indexed recipient, uint256 amount);
// Not immutable: the token's constructor needs this curve's real address,
// so the factory deploys the curve first, then the token, then wires the
// token here via `initialize()`. Set exactly once, guarded by onlyFactory.
address public token;
// Quote asset for both curve trading and the graduated pool. The zero
// address denotes native ETH.
address public immutable pairToken;
// Not immutable: the creator can hand off future fee sweeps to a new
// address (or the factory can override on the protocol owner's behalf)
// via `setCreatorFeeRecipient`, both gated through `onlyFactory`.
address public deployer;
address public immutable factory;
IPonsV2FeePolicy public immutable feePolicy;
IPonsV2FeeEscrow public immutable feeEscrow;
PonsV2BuybackVault public immutable buybackVault;
// These terms are frozen when the launch is created. Global hook policy
// updates affect future launches but cannot redirect an active curve's
// protocol share or change its buyback economics.
address public immutable protocolFeeRecipient;
address public immutable buybackCreatorRecipient;
uint16 public immutable protocolFeeShareBps;
uint16 public immutable buybackBurnBps;
uint16 public immutable maxInternalPriceImpactBps;
// Virtual quote reserve seeded at deploy, denominated in the quote
// asset's own decimals rather than always in wei.
uint256 public immutable phantomQuote;
uint256 public immutable feeBps;
// Creator-chosen at launch, capped by the protocol at launch time. Kept
// entirely separate from feeBps: it is layered on top of the base trade
// fee, not part of the protocol/buyback/creator split, and is paid to
// the creator in full.
uint256 public immutable creatorTaxBps;
uint256 public immutable graduationThreshold;
bool public buybackEnabled;
uint256 public quoteFeeBalance;
// The slice of `quoteFeeBalance` already earmarked for buyback-and-lock,
// set aside as each fee was charged under whatever the buyback flag said
// at that moment. Bucketing at accrual rather than deriving the slice at
// sweep time keeps the flag forward-looking: toggling it decides how the
// next trade's fee is split, never how an already-charged one is. It is
// not a separate pot, only a marker on part of the pending balance, so
// the protocol's share is still taken off the whole fee.
uint256 public buybackQuoteBalance;
uint256 public creatorTaxBalance;
// Net real quote asset held from curve trading: buys add their value,
// sell payouts and swept protocol/creator fees subtract theirs. Tracked
// explicitly instead of reading a live balance, so a forced transfer in
// (an ERC-20 airdrop, or ETH from a selfdestruct) can neither inflate
// curve pricing nor push a launch past its graduation threshold with no
// tokens actually sold.
uint256 public trackedQuote;
// Launch tokens this curve holds as tradeable reserve: set to the minted
// allocation at initialize, reduced by buys and the internal buyback,
// increased by sells. The token side needs the same treatment as the
// quote side because both feed the constant-product price. Reading a
// live balance would let any holder transfer tokens straight in to move
// the curve's pricing, delay graduation past the point the launch's
// economics were quoted at, and shift what the graduated pool opens at.
uint256 public trackedTokens;
bool public graduated;
// Token balance the curve will never sell below, set once at initialize
// and handed to the graduated pool intact. Everything above it is the
// sellable allocation, and graduation is exactly its exhaustion.
uint256 public reservedTokens;
// Total supply this launch was created with, snapshotted at initialize
// and exposed for off-chain consumers. Held here rather than read live
// from the token because the token is burnable, so its own totalSupply
// stops describing the supply the launch was configured around.
uint256 public launchSupply;
// Timestamp trading opened, anchoring the snipe tax decay. Set once at
// initialize, which the factory calls in the launch transaction itself,
// so second zero of the decay is the launch second.
uint256 public launchedAt;
// Anti-snipe tax terms, snapshotted from the factory at initialize like
// the rest of this launch's economics. Frozen rather than read live so
// a factory retune can never change the terms of a launch whose window
// is already open: a launch created before the change keeps the setting
// it was created under. A zero starting tax disables the mechanism for
// this curve permanently.
uint256 public snipeTaxStartBps;
uint256 public snipeTaxSeconds;
// Wallets the creator declared at launch, exempt from the snipe tax so
// a team's own bundled buys are not eaten by the launch window's
// anti-bot pricing. Written only by the factory during the launch
// transaction.
mapping(address account => bool exempt) public snipeTaxExempt;
modifier onlyFactory() {
if (msg.sender != factory) revert NotFactory();
_;
}
modifier onlyInitialized() {
if (token == address(0)) revert NotInitialized();
_;
}
/**
* @param pairToken_ Quote asset for curve trading and the graduated pool; zero for native ETH.
* @param deployer_ Token creator, credited as the creator fee recipient.
* @param factory_ PonsV2LaunchFactory address, the only caller allowed through `onlyFactory`.
* @param feePolicy_ Shared policy used only for the rotatable sweep operator.
* @param policy_ Economic terms frozen for this launch's fee sweeps.
* @param feeEscrow_ Shared claimable balance ledger for both ETH and ERC-20 revenue.
* @param buybackVault_ Shared five-year vesting lock the buyback leg deposits into instead of burning.
* @param phantomQuote_ Virtual quote reserve seeded at deploy, never physically held.
* @param feeBps_ Trade fee in basis points, always charged on the quote leg.
* @param creatorTaxBps_ Additional creator-chosen trade tax in basis points, layered on top of feeBps_.
* @param buybackEnabled_ Whether this launch initially routes its configured fee share into buyback-and-lock.
* @param graduationThreshold_ Real quote reserve required before graduation unlocks.
*/
constructor(
address pairToken_,
address deployer_,
address factory_,
IPonsV2FeePolicy feePolicy_,
FeePolicySnapshot memory policy_,
IPonsV2FeeEscrow feeEscrow_,
PonsV2BuybackVault buybackVault_,
uint256 phantomQuote_,
uint256 feeBps_,
uint256 creatorTaxBps_,
bool buybackEnabled_,
uint256 graduationThreshold_
) {
if (deployer_ == address(0) || factory_ == address(0)) revert ZeroAddress();
if (address(feePolicy_) == address(0) || address(feeEscrow_) == address(0)) revert ZeroAddress();
if (address(buybackVault_) == address(0)) revert ZeroAddress();
if (
policy_.protocolFeeRecipient == address(0) || policy_.protocolFeeShareBps > BASIS_POINTS
|| policy_.buybackBurnBps > BASIS_POINTS || policy_.maxInternalPriceImpactBps == 0
|| policy_.maxInternalPriceImpactBps >= BASIS_POINTS
) {
revert InvalidFeePolicy();
}
// The factory applies the same ceiling before deploying, but the curve
// defends its own invariant rather than inheriting it: a combined fee
// at or above the whole trade would break the quote accounting.
if (feeBps_ + creatorTaxBps_ > MAX_TOTAL_TRADE_FEE_BPS) revert InvalidFeePolicy();
pairToken = pairToken_;
deployer = deployer_;
// Passed explicitly rather than read from msg.sender: PonsV2LaunchFactory
// deploys this curve indirectly through PonsV2LaunchDeployer to keep its
// own bytecode under EIP-170's size limit, so msg.sender at construction
// time would otherwise resolve to that deployer helper, not the factory.
factory = factory_;
feePolicy = feePolicy_;
feeEscrow = feeEscrow_;
buybackVault = buybackVault_;
protocolFeeRecipient = policy_.protocolFeeRecipient;
buybackCreatorRecipient = deployer_;
protocolFeeShareBps = policy_.protocolFeeShareBps;
buybackBurnBps = policy_.buybackBurnBps;
maxInternalPriceImpactBps = policy_.maxInternalPriceImpactBps;
phantomQuote = phantomQuote_;
feeBps = feeBps_;
creatorTaxBps = creatorTaxBps_;
buybackEnabled = buybackEnabled_;
graduationThreshold = graduationThreshold_;
}
/**
* @notice True when this launch trades and graduates against native ETH.
*/
function isNativeQuote() public view returns (bool) {
return pairToken == address(0);
}
/**
* @notice Wires the launch token this curve dispenses. Called once by the
* factory immediately after deploying the token with this curve's (now
* known) address, before either contract is reachable by anyone else.
*
* @dev Also fixes the pool's token allocation, which is why this cannot
* happen in the constructor: the supply is only known once the token
* exists. Holding `phantomQuote * supply` constant, the curve reaches a
* real quote reserve of `graduationThreshold` exactly when its token
* balance falls to `supply * phantomQuote / (phantomQuote + threshold)`.
* Reserving that balance therefore does not change where a launch
* graduates, it only stops the curve selling through it: the quote
* threshold and the token allocation are the same point, so whichever
* one is used as the trigger, the graduated pool is seeded with the same
* amounts at the same price on every launch.
*/
function initialize(address token_) external onlyFactory {
if (token != address(0)) revert AlreadyInitialized();
if (token_ == address(0)) revert ZeroAddress();
token = token_;
uint256 supply = IERC20(token_).totalSupply();
uint256 reserved = Math.mulDiv(supply, phantomQuote, phantomQuote + graduationThreshold);
// A launch whose allocation rounds away has nothing to seed its pool
// with, and its final buy would revert against an empty token side.
// Rejecting the config here fails at launch rather than at graduation.
if (reserved == 0 || reserved >= supply) revert InvalidLaunchEconomics();
reservedTokens = reserved;
launchSupply = supply;
launchedAt = block.timestamp;
snipeTaxStartBps = IPonsV2SnipeTax(factory).snipeTaxStartBps();
snipeTaxSeconds = IPonsV2SnipeTax(factory).snipeTaxSeconds();
// The allocation the curve actually received, which is the whole
// supply: the token mints to this curve in its own constructor.
trackedTokens = IERC20(token_).balanceOf(address(this));
emit Initialized(token_);
}
/**
* @notice Tokens still available to buy before the curve graduates.
*/
function sellableTokens() public view returns (uint256) {
uint256 tracked = trackedTokens;
return tracked > reservedTokens ? tracked - reservedTokens : 0;
}
/**
* @notice Snipe tax `recipient` would pay on a buy landing right now, in
* basis points of the quote leg. Starts at this launch's frozen
* `snipeTaxStartBps` in the launch second and decays exponentially to
* zero across `snipeTaxSeconds`, both snapshotted from the factory when
* the curve initialized. Exempt wallets and a disabled tax both read as
* zero.
* @dev The decay is fourteen successive halvings spread evenly across
* the window, done with right shifts so it stays in integer arithmetic.
* Fourteen because 2^14 exceeds the maximum 9,900 starting tax, so the
* tax always reaches zero inside the window rather than cutting off at
* a still-meaningful rate. The decay anchors to `launchedAt`, set in
* the launch transaction itself, so second zero is the first second the
* token is publicly buyable.
*/
function currentSnipeTaxBps(address recipient) public view returns (uint256) {
if (snipeTaxExempt[recipient]) return 0;
uint256 startBps = snipeTaxStartBps;
if (startBps == 0) return 0;
uint256 elapsed = block.timestamp - launchedAt;
uint256 window = snipeTaxSeconds;
if (elapsed >= window) return 0;
return startBps >> ((elapsed * 14) / window);
}
/**
* @notice Marks `account` as exempt from the snipe tax. Called by the
* factory during the launch transaction for the creator, their fee
* recipient, and any bundle wallets the creator declared, so a team's
* own opening buys clear at the untaxed price while sniper bots in the
* same window do not.
*/
function exemptFromSnipeTax(address account) external onlyFactory {
snipeTaxExempt[account] = true;
emit SnipeTaxExempted(account);
}
/**
* @notice Updates who receives creator fees from future sweeps.
* Restricted to the factory, which gates both self-service creator
* transfers and protocol-owner overrides before forwarding here, so
* this contract only needs to trust one caller.
*/
function setCreatorFeeRecipient(address newRecipient) external onlyFactory {
if (newRecipient == address(0)) revert ZeroAddress();
emit CreatorFeeRecipientUpdated(deployer, newRecipient);
deployer = newRecipient;
}
/**
* @notice Enables or disables this launch's buyback-and-lock fee route.
* The factory authorizes both the current creator recipient and protocol
* owner before forwarding the setting here.
* @dev Applies to fees charged from here on, not to fees already pending.
* Each trade earmarks its buyback slice as it is charged, so a toggle
* cannot reach back and reroute value that accrued under the opposite
* setting. Without that, a disable landing before a sweep would divert a
* buyback the creator had already earned into their own payout, and an
* enable would sweep fees earned under a plain split into the vest.
*/
function setBuybackEnabled(bool enabled) external onlyFactory {
buybackEnabled = enabled;
emit BuybackEnabledUpdated(enabled);
}
/**
* @notice Returns the curve's current tradeable reserves, excluding fees pending sweep.
*/
function getReserves() public view returns (uint256 quoteReserve_, uint256 tokenReserve_) {
quoteReserve_ = phantomQuote + trackedQuote - quoteFeeBalance - creatorTaxBalance;
tokenReserve_ = trackedTokens;
}
/**
* @notice Tradeable quote reserve only, matching IPonsV2BondingCurve.
*/
function quoteReserve() external view returns (uint256 quoteReserve_) {
(quoteReserve_,) = getReserves();
}
/**
* @notice Returns physically held tradeable quote asset, excluding virtual
* liquidity and balances already earmarked as fees or creator tax.
*/
function realQuoteReserve() public view returns (uint256) {
return trackedQuote - quoteFeeBalance - creatorTaxBalance;
}
/**
* @notice Tradeable token reserve only, matching IPonsV2BondingCurve.
*/
function tokenReserve() external view returns (uint256 tokenReserve_) {
(, tokenReserve_) = getReserves();
}
/**
* @notice True once the curve's sellable allocation has been bought out.
* @dev Equivalent to the real quote reserve reaching `graduationThreshold`,
* since the reserved balance is derived from that same point. Expressed
* against the token side because that is the one a buy cannot overshoot:
* the quote side is a floor that a large trade could sail past, while the
* token side is a hard stop the curve refuses to cross.
*/
function readyToGraduate() public view returns (bool) {
if (graduated) return false;
return sellableTokens() == 0;
}
/**
* @notice Buys the launch token with this launch's quote asset. The fee is
* always taken from the quote leg, so this curve never holds a
* memecoin-denominated fee.
* @dev `quoteIn` must equal `msg.value` for a native launch, and must be
* accompanied by no value at all for an ERC-20 launch. The credited
* amount for an ERC-20 is the observed balance delta rather than the
* requested amount, so a fee-on-transfer quote asset cannot make the
* curve promise reserves it never received.
*
* A buy that would take the curve past its reserved allocation is filled
* only up to that allocation, charged for what it actually received, and
* refunded the difference. It is deliberately not rejected: the last buy
* of a launch is the one most likely to be sized against a state someone
* else has already moved, and reverting would let anyone grief it by
* slipping a small buy in ahead.
*
* Buys landing in the opening seconds of a launch additionally pay the
* decaying snipe tax (see `currentSnipeTaxBps`) unless the recipient was
* exempted at launch. The tax comes off the quote leg before pricing, so
* a sniper's spend mostly accrues as fees instead of buying tokens, and
* it decays to nothing within seconds for ordinary buyers.
*
* Partial fills reinterpret `minTokensOut` as a bound on price rather
* than on quantity, since a caller who spends less than they offered
* cannot expect the whole quantity they asked for. The requirement is
* that the price paid is no worse than the price implied by the caller's
* own arguments, and when nothing is clamped it reduces exactly to
* `tokensOut >= minTokensOut`.
*/
function buy(uint256 quoteIn, uint256 minTokensOut, address recipient)
external
payable
nonReentrant
onlyInitialized
returns (uint256 tokensOut)
{
if (graduated) revert CurveGraduated();
if (recipient == address(0)) revert ZeroAddress();
uint256 received = _receiveQuote(quoteIn);
if (received == 0) revert ZeroAmount();
// graduate() is deliberately not nonReentrant and the factory's
// trigger is permissionless, so a quote asset that yields control
// during transferFrom can drain this curve between the check above
// and the reserve reads below. Re-checking here rather than relying
// on the downstream arithmetic to happen to revert.
if (graduated) revert CurveGraduated();
uint256 quoteReserveBefore = phantomQuote + trackedQuote - quoteFeeBalance - creatorTaxBalance;
uint256 tokenReserveBefore = trackedTokens;
// The snipe tax rides the quote leg like the base fee and creator
// tax, but is bounded so the combined take always nets the buyer at
// least 1% of their spend and the gross-up below never divides by
// zero. It deliberately ignores MAX_TOTAL_TRADE_FEE_BPS: a 99% take
// in the launch second is the entire point. The bound only matters
// to a nonzero tax, so the common untaxed buy skips it.
uint256 snipeTaxBps = currentSnipeTaxBps(recipient);
if (snipeTaxBps != 0) {
uint256 maxSnipeTaxBps = BASIS_POINTS - feeBps - creatorTaxBps - 100;
if (snipeTaxBps > maxSnipeTaxBps) snipeTaxBps = maxSnipeTaxBps;
}
uint256 spent = received;
uint256 fee = (spent * feeBps) / BASIS_POINTS;
uint256 tax = (spent * creatorTaxBps) / BASIS_POINTS;
uint256 snipeTax = (spent * snipeTaxBps) / BASIS_POINTS;
tokensOut = PonsV2BondingCurveMath.getAmountOut(
spent - fee - tax - snipeTax, quoteReserveBefore, tokenReserveBefore, 0
);
uint256 sellable = tokenReserveBefore > reservedTokens ? tokenReserveBefore - reservedTokens : 0;
if (sellable == 0) revert CurveGraduated();
if (tokensOut > sellable) {
tokensOut = sellable;
// Price the clamped fill from the token side, then gross the
// result back up so the fee legs still come out of the input.
uint256 net = PonsV2BondingCurveMath.getAmountIn(sellable, quoteReserveBefore, tokenReserveBefore, 0);
spent = Math.min(
Math.mulDiv(net, BASIS_POINTS, BASIS_POINTS - feeBps - creatorTaxBps - snipeTaxBps, Math.Rounding.Ceil),
received
);
fee = (spent * feeBps) / BASIS_POINTS;
tax = (spent * creatorTaxBps) / BASIS_POINTS;
snipeTax = (spent * snipeTaxBps) / BASIS_POINTS;
}
// Price bound rather than quantity bound, so a partial fill honours
// the caller's terms instead of failing them. Identical to
// `tokensOut >= minTokensOut` whenever `spent == received`.
if (spent * minTokensOut > received * tokensOut) revert SlippageExceeded(tokensOut, minTokensOut);
// The snipe tax joins the base fee bucket, so it splits between
// protocol, creator, and buyback under the launch's frozen policy
// through the ordinary sweep path instead of needing accounting of
// its own.
_accrueFees(fee + snipeTax, tax);
trackedQuote += spent;
trackedTokens -= tokensOut;
IERC20(token).safeTransfer(recipient, tokensOut);
uint256 refund = received - spent;
if (refund != 0) {
emit CurveBuyRefunded(msg.sender, refund);
_sendQuote(msg.sender, refund);
}
if (snipeTax != 0) emit SnipeTaxCharged(recipient, snipeTax);
emit CurveBuy(msg.sender, recipient, spent, tokensOut, fee + snipeTax, tax);
_tryAutoGraduate();
}
/**
* @notice Sells the launch token back to the curve for the quote asset.
* The fee is taken from the quote output, so it is always
* quote-denominated here too.
* @dev Closed once the sellable allocation is exhausted, not merely once
* `graduated` is set. `_tryAutoGraduate` swallows a failed graduation so
* a problem there cannot take the crossing buy down with it, which leaves
* a window where the curve is ready but the flag is still false. `buy`
* already refuses that state through its own `sellable == 0` check, and
* `sell` has to match: `graduate` hands the pool whatever `trackedTokens`
* holds, so a sell landing in the window would put tokens back on the
* curve and take quote off it, and the pool would then be seeded deeper
* and cheaper than the reserved allocation fixes it at. The deterministic
* graduation price only holds if the window is closed on both sides.
*
* This cannot strand a holder. `graduate` is permissionless, so anyone
* blocked here can settle the launch themselves in the same transaction
* and trade the V4 pool instead.
*/
function sell(uint256 tokensIn, uint256 minQuoteOut, address recipient)
external
nonReentrant
onlyInitialized
returns (uint256 quoteOut)
{
if (graduated || readyToGraduate()) revert CurveGraduated();
if (tokensIn == 0) revert ZeroAmount();
if (recipient == address(0)) revert ZeroAddress();
(uint256 quoteReserveBefore, uint256 tokenReserveBefore) = getReserves();
IERC20(token).safeTransferFrom(msg.sender, address(this), tokensIn);
uint256 grossQuoteOut = PonsV2BondingCurveMath.getAmountOut(tokensIn, tokenReserveBefore, quoteReserveBefore, 0);
uint256 fee = (grossQuoteOut * feeBps) / BASIS_POINTS;
uint256 tax = (grossQuoteOut * creatorTaxBps) / BASIS_POINTS;
quoteOut = grossQuoteOut - fee - tax;
if (quoteOut < minQuoteOut) revert SlippageExceeded(quoteOut, minQuoteOut);
_accrueFees(fee, tax);
trackedQuote -= quoteOut;
trackedTokens += tokensIn;
_sendQuote(recipient, quoteOut);
emit CurveSell(msg.sender, recipient, tokensIn, quoteOut, fee, tax);
}
/**
* @notice Distributes pending quote fees across protocol, buyback-and-lock,
* and the creator using this launch's frozen policy. The trusted sweep
* operator is required when the sweep would execute an internal buyback.
* The creator may still distribute fees when no swap is required.
* @dev Reverts once graduated rather than silently no-op'ing. `graduate()`
* already drains `quoteFeeBalance`/`creatorTaxBalance` to zero before
* setting the flag, and trading is halted afterward so they can never
* refill, but making the guard explicit here keeps that invariant
* self-evident instead of depending on reasoning across two functions.
*/
function sweepFees(uint256 minBuybackTokensOut) external nonReentrant {
if (graduated) revert AlreadyGraduated();
bool isOperator = msg.sender == feePolicy.feeSweepOperator();
if (!isOperator && msg.sender != deployer) {
revert NotFeeSweepOperator();
}
if (!isOperator && _requiresTrustedOperator()) revert InternalSwapRequiresOperator();
_sweepFees(minBuybackTokensOut, true);
}
/**
* @notice Sweeps fees, halts trading, and hands the remaining tradeable
* reserves to the factory so it can seed the graduated Uniswap V4 pool.
* Because the curve already holds the pool's quote asset, the factory
* receives exactly what it needs to seed with, and no conversion step
* sits between the two. Restricted to the factory; deliberately not
* `nonReentrant` since it may be invoked from within `buy()`'s own
* reentrancy-guarded scope.
*/
function graduate(address recipient) external onlyFactory returns (uint256 quoteOut, uint256 tokenOut) {
if (graduated) revert AlreadyGraduated();
if (recipient == address(0)) revert ZeroAddress();
if (!readyToGraduate()) revert NotReadyToGraduate();
// Halt trading before the sweep, not after. The sweep pays the escrow,
// and a quote asset with a transfer callback can re-enter buy() or
// sell() from inside that payment. This function is deliberately not
// nonReentrant so it stays callable from within buy()'s own guarded
// scope, so the flag is the only thing closing that window. Reentering
// while it was still false repopulated the fee buckets after they had
// been zeroed, leaving balances with no quote behind them once the
// reserve was handed over, and no way to ever sweep them.
//
// Safe to set here: readyToGraduate() is already evaluated above, and
// the private _sweepFees never reads the flag.
graduated = true;
// Graduation may be triggered by any caller or by the threshold-
// crossing buyer. Skip the buyback rather than execute a predictable
// market order without the sweep operator's minimum output.
_sweepFees(0, false);
// Hand over only the tracked trading reserves. Any quote asset or
// launch token force-sent to this curve is deliberately left stranded
// here rather than folded into the graduated pool's seed, so a
// donation cannot move the price the pool opens at.
quoteOut = trackedQuote;
trackedQuote = 0;
tokenOut = trackedTokens;
trackedTokens = 0;
if (quoteOut != 0) {
_sendQuote(recipient, quoteOut);
}
if (tokenOut != 0) {
IERC20(token).safeTransfer(recipient, tokenOut);
}
emit CurveCompleted(recipient, quoteOut, tokenOut);
}
/**
* @dev Pulls `amount` of the quote asset from the caller and returns the
* amount actually received. Native launches take it from `msg.value`;
* ERC-20 launches measure the balance delta so a fee-on-transfer quote
* asset is credited for what arrived, not what was asked for.
*/
function _receiveQuote(uint256 amount) private returns (uint256) {
if (isNativeQuote()) {
if (msg.value != amount) revert NativeValueMismatch(msg.value, amount);
return amount;
}
if (msg.value != 0) revert UnexpectedNativeValue();
IERC20 quote = IERC20(pairToken);
uint256 balanceBefore = quote.balanceOf(address(this));
quote.safeTransferFrom(msg.sender, address(this), amount);
return quote.balanceOf(address(this)) - balanceBefore;
}
/**
* @dev Pays `amount` of the quote asset out to `recipient`.
*/
function _sendQuote(address recipient, uint256 amount) private {
if (isNativeQuote()) {
(bool sent,) = payable(recipient).call{value: amount}("");
if (!sent) revert TransferFailed();
return;
}
IERC20(pairToken).safeTransfer(recipient, amount);
}
/**
* @dev Credits `amount` of the quote asset to `recipient`'s claimable
* escrow balance, using whichever of the escrow's two ledgers matches.
*/
function _creditQuote(address recipient, uint256 amount) private {
if (isNativeQuote()) {
feeEscrow.credit{value: amount}(recipient);
return;
}
IERC20(pairToken).forceApprove(address(feeEscrow), amount);
feeEscrow.creditToken(recipient, pairToken, amount);
}
/**
* @dev Attempts to graduate the instant a buy crosses the threshold, so
* the crossing trade itself triggers the migration atomically. Wrapped in
* try/catch: if graduation reverts for any reason (for example a pool the
* factory cannot yet seed), the underlying buy must still succeed, and
* graduation stays permissionlessly retryable via the factory.
*
* A failure is announced rather than swallowed silently. The crossing
* buyer sets their own gas limit and can starve this call under the 63/64
* rule, pushing graduation's cost onto whoever calls next, so the event is
* what lets a keeper notice a launch sitting ready but ungraduated.
*/
function _tryAutoGraduate() private {
if (readyToGraduate()) {
try IPonsV2LaunchFactoryGraduation(factory).graduate(token) {}
catch {
emit AutoGraduationFailed(token, gasleft());
}
}
}
/**
* @dev Books a trade's base fee and creator tax, earmarking the buyback
* slice at the moment the fee is charged. The slice comes out of the
* creator's bucket alone, so it is measured against what remains after
* the protocol's share, and the tax never enters the split at all.
*/
function _accrueFees(uint256 fee, uint256 tax) private {
quoteFeeBalance += fee;
creatorTaxBalance += tax;
if (buybackEnabled && fee != 0) {
uint256 creatorSlice = fee - (fee * protocolFeeShareBps) / BASIS_POINTS;
buybackQuoteBalance += (creatorSlice * buybackBurnBps) / BASIS_POINTS;
}
}
/**
* @dev Returns whether a pending base-fee balance would execute a
* pool-priced buyback. The creator can distribute direct fees but cannot
* choose a permissive price floor for inventory shared with the protocol.
*/
function _requiresTrustedOperator() private view returns (bool) {
return buybackQuoteBalance != 0;
}
/**
* @dev Splits pending quote fees into protocol / buyback-and-lock /
* creator using the launch's frozen policy, swapping the buyback slice for
* the memecoin against this curve's own reserves before locking it into
* the shared five-year vest instead of burning it. Reserves for the swap
* are read before `quoteFeeBalance` is cleared, so the entire pending
* balance is correctly excluded from the pre-swap tradeable reserve. The
* buyback's price impact is bounded by the same `maxInternalPriceImpactBps`
* the post-graduation hook enforces on its own internal swaps, and its size
* by the same `reservedTokens` floor `buy` respects. A caller cannot
* execute the swap without supplying an explicit output floor.
*/
function _sweepFees(uint256 minBuybackTokensOut, bool executeBuyback) private {
uint256 pending = quoteFeeBalance;
uint256 tax = creatorTaxBalance;
if (pending == 0 && tax == 0) return;
uint256 protocolAmount = (pending * protocolFeeShareBps) / BASIS_POINTS;
uint256 creatorBucket = pending - protocolAmount;
// The earmark was summed per trade, so its rounding can land a wei or
// two above the bucket recomputed here on the aggregate. Clamping
// keeps the subtraction below sound at a full buyback share, where
// the two would otherwise be equal.
uint256 buybackAmount = executeBuyback ? Math.min(buybackQuoteBalance, creatorBucket) : 0;
// The creator tax bypasses the protocol/buyback split entirely: it is
// charged on top of the base fee and paid to the creator in full.
uint256 creatorAmount = creatorBucket - buybackAmount + tax;
uint256 tokensLocked;
if (buybackAmount != 0) {
if (minBuybackTokensOut == 0) revert MinimumOutputRequired();
(uint256 quoteReserve_, uint256 tokenReserve_) = getReserves();
// This reserve-movement ratio is equivalent to the hook's
// sqrtPriceX96 limit for a constant-product quote-to-token swap.
uint256 reserveMovementBps = (buybackAmount * BASIS_POINTS) / (quoteReserve_ + buybackAmount);
if (reserveMovementBps <= maxInternalPriceImpactBps) {
// The non-reverting quote, so a curve too thin to price the
// buyback reaches the fold-back below instead of taking the
// whole fee sweep down with it.
uint256 tokensOut =
PonsV2BondingCurveMath.quoteAmountOut(buybackAmount, quoteReserve_, tokenReserve_, 0);
// The buyback takes tokens off the same reserve `buy` does, so
// it answers to the same floor. Only the balance above
// `reservedTokens` is sellable; the remainder is the graduated
// pool's allocation. As a launch nears graduation the sellable
// amount approaches zero and the buyback folds back into the
// creator payout below rather than eating into that allocation.
if (tokensOut != 0 && tokensOut <= sellableTokens()) {
tokensLocked = tokensOut;
}
}
if (tokensLocked == 0) {
// Curve too shallow or the buyback would move its price too
// far; fold it back into the creator's payout instead.
creatorAmount += buybackAmount;
buybackAmount = 0;
} else if (tokensLocked < minBuybackTokensOut) {
// Only a buyback that actually executes is subject to the
// caller's minimum. Applying it to the fold-back branch would
// make that branch unreachable, since every accepted argument
// is above the zero it produces, and pending fees would be
// stranded exactly when the curve is too thin to buy back.
revert SlippageExceeded(tokensLocked, minBuybackTokensOut);
}
}
quoteFeeBalance = 0;
// Cleared unconditionally. Whether the buyback executed, folded back
// into the creator's payout, or was skipped outright by graduation,
// the fees behind the earmark have now been distributed.
buybackQuoteBalance = 0;
creatorTaxBalance = 0;
// Protocol and creator amounts leave the contract; the buyback slice
// stays as tradeable reserve, so only the paid-out legs reduce the
// tracked quote balance.
trackedQuote -= protocolAmount + creatorAmount;
if (tokensLocked != 0) {
// The buyback buys the memecoin off this curve's own reserve, so
// the tokens it locks leave the tradeable side.
trackedTokens -= tokensLocked;
IERC20(token).forceApprove(address(buybackVault), tokensLocked);
buybackVault.lock(token, tokensLocked, buybackCreatorRecipient, protocolFeeRecipient, protocolFeeShareBps);
emit BuybackLocked(buybackAmount, tokensLocked);
}
if (protocolAmount != 0) {
_creditQuote(protocolFeeRecipient, protocolAmount);
}
if (creatorAmount != 0) {
_creditQuote(deployer, creatorAmount);
}
emit FeesSwept(protocolAmount, buybackAmount, creatorAmount);
}
/**
* @notice Pays this curve's pending fees straight to the protocol and
* creator recipients, bypassing the escrow. Restricted to the factory,
* which gates it on the protocol owner.
*
* @dev Exists because an ordinary sweep routes every payout through
* PonsV2FeeEscrow, and a permissioned quote asset can stop delivering to
* that one address while still permitting transfers between traders and
* this curve. Trading then continues normally, but the fees are
* unreachable, and graduation is unreachable with them: `graduate` sweeps
* before it hands over the reserves, and fees accrue from the first
* trade, so the sweep is never a no-op by the time the threshold is
* crossed. The launch would be stuck on its curve forever.
*
* Clearing the buckets here is what unblocks that: the sweep inside
* `graduate` then finds nothing pending and returns early, so graduation
* proceeds without this function needing to touch it.
*
* The buyback slice is deliberately skipped rather than executed. It
* would have to settle through the vault and the same escrow, which is
* the dependency this path exists to route around, so the whole creator
* bucket is paid out directly instead.
*
* Mirrors PonsV2MemeHook.rescuePoolFees for the post-graduation pool and
* PonsV2LaunchFactory.rescueSweptGraduation for the reserves in between.
*/
function rescueFees() external onlyFactory returns (uint256 protocolAmount, uint256 creatorAmount) {
uint256 pending = quoteFeeBalance;
uint256 tax = creatorTaxBalance;
if (pending == 0 && tax == 0) revert ZeroAmount();
protocolAmount = (pending * protocolFeeShareBps) / BASIS_POINTS;
creatorAmount = pending - protocolAmount + tax;
quoteFeeBalance = 0;
// Symmetrical with the sweep. This pays the creator their whole
// bucket, earmark included, so leaving the earmark behind would let a
// settled claim survive into the next accrual and divert fees the
// creator has not earned yet into the vest.
buybackQuoteBalance = 0;
creatorTaxBalance = 0;
trackedQuote -= protocolAmount + creatorAmount;
if (protocolAmount != 0) _sendQuote(protocolFeeRecipient, protocolAmount);
if (creatorAmount != 0) _sendQuote(deployer, creatorAmount);
emit FeesRescued(protocolFeeRecipient, deployer, protocolAmount, creatorAmount);
}
}
contracts/lib/openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC1363} from "../../../interfaces/IERC1363.sol";
import {IERC20Metadata} from "../../../interfaces/IERC20Metadata.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC-20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
/**
* @dev An operation with an ERC-20 token failed.
*/
error SafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/
error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
if (!_safeTransfer(token, to, value, true)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
if (!_safeTransferFrom(token, from, to, value, true)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Variant of {safeTransfer} that returns a bool instead of reverting if the operation is not successful.
*/
function trySafeTransfer(IERC20 token, address to, uint256 value) internal returns (bool) {
return _safeTransfer(token, to, value, false);
}
/**
* @dev Variant of {safeTransferFrom} that returns a bool instead of reverting if the operation is not successful.
*/
function trySafeTransferFrom(IERC20 token, address from, address to, uint256 value) internal returns (bool) {
return _safeTransferFrom(token, from, to, value, false);
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
forceApprove(token, spender, oldAllowance + value);
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
* value, non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
unchecked {
uint256 currentAllowance = token.allowance(address(this), spender);
if (currentAllowance < requestedDecrease) {
revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
}
forceApprove(token, spender, currentAllowance - requestedDecrease);
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*
* NOTE: If the token implements ERC-7674, this function will not modify any temporary allowance. This function
* only sets the "standard" allowance. Any temporary allowance will remain active, in addition to the value being
* set here.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
if (!_safeApprove(token, spender, value, false)) {
if (!_safeApprove(token, spender, 0, true)) revert SafeERC20FailedOperation(address(token));
if (!_safeApprove(token, spender, value, true)) revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that relies on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
safeTransfer(token, to, value);
} else if (!token.transferAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target
* has no code. This can be used to implement an {ERC721}-like safe transfer that relies on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferFromAndCallRelaxed(
IERC1363 token,
address from,
address to,
uint256 value,
bytes memory data
) internal {
if (to.code.length == 0) {
safeTransferFrom(token, from, to, value);
} else if (!token.transferFromAndCall(from, to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}.
* Oppositely, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall}
* once without retrying, and relies on the returned value to be true.
*
* Reverts if the returned value is other than `true`.
*/
function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
forceApprove(token, to, value);
} else if (!token.approveAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/// @dev Attempts to fetch the token decimals. A return value of false indicates that the attempt failed in some way.
function tryGetDecimals(IERC20 token) internal view returns (bool success, uint8 decimals) {
bytes4 selector = IERC20Metadata.decimals.selector;
assembly ("memory-safe") {
mstore(0x00, selector)
success := staticcall(gas(), token, 0x00, 4, 0x00, 0x20)
success := and(and(success, gt(returndatasize(), 0x1f)), lt(mload(0x00), 0x100))
decimals := mul(success, mload(0x00))
}
}
/**
* @dev Imitates a Solidity `token.transfer(to, value)` call, relaxing the requirement on the return value: the
* return value is optional (but if data is returned, it must not be false).
*
* @param token The token targeted by the call.
* @param to The recipient of the tokens
* @param value The amount of token to transfer
* @param bubble Behavior switch if the transfer call reverts: bubble the revert reason or return a false boolean.
*/
function _safeTransfer(IERC20 token, address to, uint256 value, bool bubble) private returns (bool success) {
bytes4 selector = IERC20.transfer.selector;
assembly ("memory-safe") {
let fmp := mload(0x40)
mstore(0x00, selector)
mstore(0x04, and(to, shr(96, not(0))))
mstore(0x24, value)
success := call(gas(), token, 0, 0x00, 0x44, 0x00, 0x20)
// if call success and return is true, all is good.
// otherwise (not success or return is not true), we need to perform further checks
if iszero(and(success, eq(mload(0x00), 1))) {
// if the call was a failure and bubble is enabled, bubble the error
if and(iszero(success), bubble) {
returndatacopy(fmp, 0x00, returndatasize())
revert(fmp, returndatasize())
}
// if the return value is not true, then the call is only successful if:
// - the token address has code
// - the returndata is empty
success := and(success, and(iszero(returndatasize()), gt(extcodesize(token), 0)))
}
mstore(0x40, fmp)
}
}
/**
* @dev Imitates a Solidity `token.transferFrom(from, to, value)` call, relaxing the requirement on the return
* value: the return value is optional (but if data is returned, it must not be false).
*
* @param token The token targeted by the call.
* @param from The sender of the tokens
* @param to The recipient of the tokens
* @param value The amount of token to transfer
* @param bubble Behavior switch if the transfer call reverts: bubble the revert reason or return a false boolean.
*/
function _safeTransferFrom(
IERC20 token,
address from,
address to,
uint256 value,
bool bubble
) private returns (bool success) {
bytes4 selector = IERC20.transferFrom.selector;
assembly ("memory-safe") {
let fmp := mload(0x40)
mstore(0x00, selector)
mstore(0x04, and(from, shr(96, not(0))))
mstore(0x24, and(to, shr(96, not(0))))
mstore(0x44, value)
success := call(gas(), token, 0, 0x00, 0x64, 0x00, 0x20)
// if call success and return is true, all is good.
// otherwise (not success or return is not true), we need to perform further checks
if iszero(and(success, eq(mload(0x00), 1))) {
// if the call was a failure and bubble is enabled, bubble the error
if and(iszero(success), bubble) {
returndatacopy(fmp, 0x00, returndatasize())
revert(fmp, returndatasize())
}
// if the return value is not true, then the call is only successful if:
// - the token address has code
// - the returndata is empty
success := and(success, and(iszero(returndatasize()), gt(extcodesize(token), 0)))
}
mstore(0x40, fmp)
mstore(0x60, 0)
}
}
/**
* @dev Imitates a Solidity `token.approve(spender, value)` call, relaxing the requirement on the return value:
* the return value is optional (but if data is returned, it must not be false).
*
* @param token The token targeted by the call.
* @param spender The spender of the tokens
* @param value The amount of token to transfer
* @param bubble Behavior switch if the transfer call reverts: bubble the revert reason or return a false boolean.
*/
function _safeApprove(IERC20 token, address spender, uint256 value, bool bubble) private returns (bool success) {
bytes4 selector = IERC20.approve.selector;
assembly ("memory-safe") {
let fmp := mload(0x40)
mstore(0x00, selector)
mstore(0x04, and(spender, shr(96, not(0))))
mstore(0x24, value)
success := call(gas(), token, 0, 0x00, 0x44, 0x00, 0x20)
// if call success and return is true, all is good.
// otherwise (not success or return is not true), we need to perform further checks
if iszero(and(success, eq(mload(0x00), 1))) {
// if the call was a failure and bubble is enabled, bubble the error
if and(iszero(success), bubble) {
returndatacopy(fmp, 0x00, returndatasize())
revert(fmp, returndatasize())
}
// if the return value is not true, then the call is only successful if:
// - the token address has code
// - the returndata is empty
success := and(success, and(iszero(returndatasize()), gt(extcodesize(token), 0)))
}
mstore(0x40, fmp)
}
}
}
contracts/lib/v4-core/src/libraries/Position.sol
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
import {FullMath} from "./FullMath.sol";
import {FixedPoint128} from "./FixedPoint128.sol";
import {LiquidityMath} from "./LiquidityMath.sol";
import {CustomRevert} from "./CustomRevert.sol";
/// @title Position
/// @notice Positions represent an owner address' liquidity between a lower and upper tick boundary
/// @dev Positions store additional state for tracking fees owed to the position
library Position {
using CustomRevert for bytes4;
/// @notice Cannot update a position with no liquidity
error CannotUpdateEmptyPosition();
// info stored for each user's position
struct State {
// the amount of liquidity owned by this position
uint128 liquidity;
// fee growth per unit of liquidity as of the last update to liquidity or fees owed
uint256 feeGrowthInside0LastX128;
uint256 feeGrowthInside1LastX128;
}
/// @notice Returns the State struct of a position, given an owner and position boundaries
/// @param self The mapping containing all user positions
/// @param owner The address of the position owner
/// @param tickLower The lower tick boundary of the position
/// @param tickUpper The upper tick boundary of the position
/// @param salt A unique value to differentiate between multiple positions in the same range
/// @return position The position info struct of the given owners' position
function get(mapping(bytes32 => State) storage self, address owner, int24 tickLower, int24 tickUpper, bytes32 salt)
internal
view
returns (State storage position)
{
bytes32 positionKey = calculatePositionKey(owner, tickLower, tickUpper, salt);
position = self[positionKey];
}
/// @notice A helper function to calculate the position key
/// @param owner The address of the position owner
/// @param tickLower the lower tick boundary of the position
/// @param tickUpper the upper tick boundary of the position
/// @param salt A unique value to differentiate between multiple positions in the same range, by the same owner. Passed in by the caller.
function calculatePositionKey(address owner, int24 tickLower, int24 tickUpper, bytes32 salt)
internal
pure
returns (bytes32 positionKey)
{
// positionKey = keccak256(abi.encodePacked(owner, tickLower, tickUpper, salt))
assembly ("memory-safe") {
let fmp := mload(0x40)
mstore(add(fmp, 0x26), salt) // [0x26, 0x46)
mstore(add(fmp, 0x06), tickUpper) // [0x23, 0x26)
mstore(add(fmp, 0x03), tickLower) // [0x20, 0x23)
mstore(fmp, owner) // [0x0c, 0x20)
positionKey := keccak256(add(fmp, 0x0c), 0x3a) // len is 58 bytes
// now clean the memory we used
mstore(add(fmp, 0x40), 0) // fmp+0x40 held salt
mstore(add(fmp, 0x20), 0) // fmp+0x20 held tickLower, tickUpper, salt
mstore(fmp, 0) // fmp held owner
}
}
/// @notice Credits accumulated fees to a user's position
/// @param self The individual position to update
/// @param liquidityDelta The change in pool liquidity as a result of the position update
/// @param feeGrowthInside0X128 The all-time fee growth in currency0, per unit of liquidity, inside the position's tick boundaries
/// @param feeGrowthInside1X128 The all-time fee growth in currency1, per unit of liquidity, inside the position's tick boundaries
/// @return feesOwed0 The amount of currency0 owed to the position owner
/// @return feesOwed1 The amount of currency1 owed to the position owner
function update(
State storage self,
int128 liquidityDelta,
uint256 feeGrowthInside0X128,
uint256 feeGrowthInside1X128
) internal returns (uint256 feesOwed0, uint256 feesOwed1) {
uint128 liquidity = self.liquidity;
if (liquidityDelta == 0) {
// disallow pokes for 0 liquidity positions
if (liquidity == 0) CannotUpdateEmptyPosition.selector.revertWith();
} else {
self.liquidity = LiquidityMath.addDelta(liquidity, liquidityDelta);
}
// calculate accumulated fees. overflow in the subtraction of fee growth is expected
unchecked {
feesOwed0 =
FullMath.mulDiv(feeGrowthInside0X128 - self.feeGrowthInside0LastX128, liquidity, FixedPoint128.Q128);
feesOwed1 =
FullMath.mulDiv(feeGrowthInside1X128 - self.feeGrowthInside1LastX128, liquidity, FixedPoint128.Q128);
}
// update the position
self.feeGrowthInside0LastX128 = feeGrowthInside0X128;
self.feeGrowthInside1LastX128 = feeGrowthInside1X128;
}
}
contracts/lib/v4-periphery/src/interfaces/IPositionManager.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
import {PoolId} from "@uniswap/v4-core/src/types/PoolId.sol";
import {PositionInfo} from "../libraries/PositionInfoLibrary.sol";
import {INotifier} from "./INotifier.sol";
import {IImmutableState} from "./IImmutableState.sol";
import {IERC721Permit_v4} from "./IERC721Permit_v4.sol";
import {IEIP712_v4} from "./IEIP712_v4.sol";
import {IMulticall_v4} from "./IMulticall_v4.sol";
import {IPoolInitializer_v4} from "./IPoolInitializer_v4.sol";
import {IUnorderedNonce} from "./IUnorderedNonce.sol";
import {IPermit2Forwarder} from "./IPermit2Forwarder.sol";
/// @title IPositionManager
/// @notice Interface for the PositionManager contract
interface IPositionManager is
INotifier,
IImmutableState,
IERC721Permit_v4,
IEIP712_v4,
IMulticall_v4,
IPoolInitializer_v4,
IUnorderedNonce,
IPermit2Forwarder
{
/// @notice Emitted by the position manager for each modifyLiquidity call, mirroring PoolManager
/// ModifyLiquidity except `sender` is the unlock locker (end user), not the position manager.
event ModifyPosition(
PoolId indexed id, address indexed sender, int24 tickLower, int24 tickUpper, int256 liquidityDelta, bytes32 salt
);
/// @notice Thrown when the caller is not approved to modify a position
error NotApproved(address caller);
/// @notice Thrown when the block.timestamp exceeds the user-provided deadline
error DeadlinePassed(uint256 deadline);
/// @notice Thrown when calling transfer, subscribe, or unsubscribe when the PoolManager is unlocked.
/// @dev This is to prevent hooks from being able to trigger notifications at the same time the position is being modified.
error PoolManagerMustBeLocked();
/// @notice Unlocks Uniswap v4 PoolManager and batches actions for modifying liquidity
/// @dev This is the standard entrypoint for the PositionManager
/// @param unlockData is an encoding of actions, and parameters for those actions
/// @param deadline is the deadline for the batched actions to be executed
function modifyLiquidities(bytes calldata unlockData, uint256 deadline) external payable;
/// @notice Batches actions for modifying liquidity without unlocking v4 PoolManager
/// @dev This must be called by a contract that has already unlocked the v4 PoolManager
/// @param actions the actions to perform
/// @param params the parameters to provide for the actions
function modifyLiquiditiesWithoutUnlock(bytes calldata actions, bytes[] calldata params) external payable;
/// @notice Used to get the ID that will be used for the next minted liquidity position
/// @return uint256 The next token ID
function nextTokenId() external view returns (uint256);
/// @notice Returns the liquidity of a position
/// @param tokenId the ERC721 tokenId
/// @return liquidity the position's liquidity, as a liquidityAmount
/// @dev this value can be processed as an amount0 and amount1 by using the LiquidityAmounts library
function getPositionLiquidity(uint256 tokenId) external view returns (uint128 liquidity);
/// @notice Returns the pool key and position info of a position
/// @param tokenId the ERC721 tokenId
/// @return poolKey the pool key of the position
/// @return PositionInfo a uint256 packed value holding information about the position including the range (tickLower, tickUpper)
function getPoolAndPositionInfo(uint256 tokenId) external view returns (PoolKey memory, PositionInfo);
/// @notice Returns the position info of a position
/// @param tokenId the ERC721 tokenId
/// @return a uint256 packed value holding information about the position including the range (tickLower, tickUpper)
function positionInfo(uint256 tokenId) external view returns (PositionInfo);
}
contracts/src/v2/PonsV2LaunchDeployer.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {Create2} from "@openzeppelin/contracts/utils/Create2.sol";
import {PonsV2LauncherToken} from "./PonsV2LauncherToken.sol";
import {PonsV2BondingCurve} from "./PonsV2BondingCurve.sol";
import {PonsV2BuybackVault} from "./PonsV2BuybackVault.sol";
import {FeePolicySnapshot, IPonsV2FeeEscrow, IPonsV2FeePolicy} from "./interfaces/ILaunchpadV2.sol";
/**
* @notice Every input PonsV2LaunchFactory hands the deployer to stand up one
* launch. Grouped into a single calldata struct rather than a flat parameter
* list so the deployer stays inside the EVM's 16-slot stack window when
* compiled without the IR pipeline, which is the mode `forge coverage` uses.
*/
struct LaunchDeployment {
address pairToken;
address creatorFeeRecipient;
address originalDeployer;
IPonsV2FeePolicy feePolicy;
FeePolicySnapshot policy;
IPonsV2FeeEscrow feeEscrow;
PonsV2BuybackVault buybackVault;
uint256 phantomQuote;
uint256 curveFeeBps;
uint256 creatorTaxBps;
bool buybackEnabled;
uint256 graduationThreshold;
uint256 supply;
// Creator-chosen CREATE2 salt, forwarded from TokenParams. The factory
// authenticates `originalDeployer`, which gives each initiating account
// its own salt space even when it names a separate fee recipient.
bytes32 salt;
string name;
string symbol;
string logo;
string description;
PonsV2LauncherToken.Socials socials;
}
/**
* @title PonsV2LaunchDeployer
* @notice Deploys the bonding curve and launch token pair for one pons v2
* launch on PonsV2LaunchFactory's behalf. Split out into its own contract
* purely so PonsV2LaunchFactory's own bytecode stays under EIP-170's
* 24576-byte deployed-code limit: embedding two full contracts' creation
* code via `new` inside the factory itself was the single largest
* contributor to its size. Both new contracts still record the real
* factory's address explicitly (never this deployer's), since they gate
* privileged calls on it.
*/
contract PonsV2LaunchDeployer {
// Metadata is stored on the token and read back by unbounded-return view
// functions, so an unbounded write here becomes a permanently unreadable
// token: `socials()` returns all five strings at once and would run out
// of gas or time out an RPC node. Bounding the write is the only place
// the limit can be enforced, since the strings are immutable afterwards.
uint256 private constant MAX_NAME_LENGTH = 64;
uint256 private constant MAX_SYMBOL_LENGTH = 16;
uint256 private constant MAX_LOGO_LENGTH = 512;
uint256 private constant MAX_DESCRIPTION_LENGTH = 2048;
uint256 private constant MAX_SOCIAL_LENGTH = 256;
error NotFactory();
error MetadataTooLong();
address public immutable factory;
modifier onlyFactory() {
if (msg.sender != factory) revert NotFactory();
_;
}
constructor(address factory_) {
if (factory_ == address(0)) revert NotFactory();
factory = factory_;
}
/**
* @notice Deploys a fresh curve/token pair and returns both addresses.
* Both contracts are told `factory` (not this deployer) is their
* privileged caller. Wiring the curve to its token via `initialize()` is
* left to the factory itself, since that call is `onlyFactory`-gated.
*
* @dev Deployed with CREATE2 rather than CREATE so neither address depends
* on this deployer's nonce, and therefore on the order launches happen to
* land in. Under CREATE the Nth launch simply took the Nth address, so an
* address predicted before its launch confirmed committed to nothing and
* a different launch could arrive there instead. Under CREATE2 the address
* is a function of the salt and the creation code, and the creation code
* carries every constructor argument, so an address can only ever hold the
* exact launch it was computed from.
*
* Reverts through `Create2` with `FailedDeployment` when the pair already
* exists, which is the same creator reusing a salt on otherwise identical
* terms. Callers can test for it in advance with `predictLaunchAddresses`.
*/
function deployLaunch(LaunchDeployment calldata params)
external
onlyFactory
returns (address token, address curve)
{
_requireMetadataWithinLimits(params);
bytes32 salt = _launchSalt(params);
curve = Create2.deploy(0, salt, _curveCreationCode(params));
token = Create2.deploy(0, salt, _tokenCreationCode(params, curve));
}
/**
* @notice Returns the addresses `deployLaunch` would produce for `params`,
* without deploying anything.
*
* @dev Lets a caller confirm that a launch it has not seen confirmed yet
* will land where it expects, and lets the launch path be checked for a
* salt the creator has already used. The token is derived from the curve
* because the curve's address is one of the token's constructor
* arguments, so the pair has to be computed in deployment order.
*/
function predictLaunchAddresses(LaunchDeployment calldata params)
external
view
returns (address token, address curve)
{
bytes32 salt = _launchSalt(params);
curve = Create2.computeAddress(salt, keccak256(_curveCreationCode(params)));
token = Create2.computeAddress(salt, keccak256(_tokenCreationCode(params, curve)));
}
/**
* @dev CREATE2 salt for one launch: the creator's chosen salt namespaced
* by the factory-authenticated initiating account. `creatorFeeRecipient`
* is intentionally not the namespace because any caller may name an
* arbitrary payout address and could otherwise squat another creator's
* deployment.
*/
function _launchSalt(LaunchDeployment calldata params) private pure returns (bytes32) {
return keccak256(abi.encode(params.originalDeployer, params.salt));
}
/**
* @dev Creation code for the launch's bonding curve. Shared by the deploy
* and predict paths so the two can never derive different addresses.
*/
function _curveCreationCode(LaunchDeployment calldata params) private view returns (bytes memory) {
return abi.encodePacked(
type(PonsV2BondingCurve).creationCode,
abi.encode(
params.pairToken,
params.creatorFeeRecipient,
factory,
params.feePolicy,
params.policy,
params.feeEscrow,
params.buybackVault,
params.phantomQuote,
params.curveFeeBps,
params.creatorTaxBps,
params.buybackEnabled,
params.graduationThreshold
)
);
}
/**
* @dev Creation code for the launch's token, given the curve it mints its
* whole supply to.
*/
function _tokenCreationCode(LaunchDeployment calldata params, address curve) private view returns (bytes memory) {
return abi.encodePacked(
type(PonsV2LauncherToken).creationCode,
abi.encode(
params.name,
params.symbol,
params.logo,
params.description,
params.socials,
params.originalDeployer,
curve,
factory,
params.supply
)
);
}
/**
* @notice Reverts unless every metadata string fits its length cap.
* @dev The factory already rejects an empty name or symbol, so only the
* upper bound is checked here.
*/
function _requireMetadataWithinLimits(LaunchDeployment calldata params) private pure {
if (
bytes(params.name).length > MAX_NAME_LENGTH || bytes(params.symbol).length > MAX_SYMBOL_LENGTH
|| bytes(params.logo).length > MAX_LOGO_LENGTH
|| bytes(params.description).length > MAX_DESCRIPTION_LENGTH
) {
revert MetadataTooLong();
}
if (
bytes(params.socials.twitter).length > MAX_SOCIAL_LENGTH
|| bytes(params.socials.telegram).length > MAX_SOCIAL_LENGTH
|| bytes(params.socials.discord).length > MAX_SOCIAL_LENGTH
|| bytes(params.socials.website).length > MAX_SOCIAL_LENGTH
|| bytes(params.socials.farcaster).length > MAX_SOCIAL_LENGTH
) {
revert MetadataTooLong();
}
}
}
contracts/src/v2/libraries/PonsV2GraduationMath.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
import {FullMath} from "@uniswap/v4-core/src/libraries/FullMath.sol";
/**
* @title PonsV2GraduationMath
* @notice Derives the sqrtPriceX96 needed to seed a brand-new Uniswap V4 pool
* with a single full-range position from two known token amounts. In the
* full-range limit (tickLower/tickUpper at the usable min/max ticks), a
* position's amount0 and amount1 approach `liquidity / sqrtPrice` and
* `liquidity * sqrtPrice`, so `amount1 / amount0` converges to the pool
* price. This is exact enough for seeding a graduation pool, since both
* amounts here are the bonding curve's real, non-extreme final reserves.
*/
library PonsV2GraduationMath {
error ZeroAmount();
error UnsupportedPrice();
/**
* @notice Computes sqrtPriceX96 = sqrt(amount1 / amount0) * 2^96.
* @param amount0 Amount of the pool's currency0, must be nonzero.
* @param amount1 Amount of the pool's currency1, must be nonzero.
*/
function sqrtPriceX96FromAmounts(uint256 amount0, uint256 amount1) internal pure returns (uint160) {
if (amount0 == 0 || amount1 == 0) revert ZeroAmount();
if (_fitsQ192(amount0, amount1)) {
uint256 ratioX192 = FullMath.mulDiv(amount1, 1 << 192, amount0);
// forge-lint: disable-next-line(unsafe-typecast)
return uint160(Math.sqrt(ratioX192));
}
// A Q128 ratio preserves the remaining valid V4 price range without
// requiring the intermediate Q192 quotient to fit in uint256.
if (!_fitsQ128(amount0, amount1)) revert UnsupportedPrice();
uint256 ratioX128 = FullMath.mulDiv(amount1, 1 << 128, amount0);
uint256 sqrtPriceX64 = Math.sqrt(ratioX128);
if (sqrtPriceX64 > type(uint128).max) revert UnsupportedPrice();
// sqrt(amount1 / amount0 * 2^128) is Q64. Shift it into Q96.
// forge-lint: disable-next-line(unsafe-typecast)
return uint160(sqrtPriceX64 << 32);
}
/**
* @dev A Q192 quotient fits uint256 only when amount1 / amount0 is
* strictly below 2^64. Avoiding the multiplication also avoids overflow.
*/
function _fitsQ192(uint256 amount0, uint256 amount1) private pure returns (bool) {
if (amount0 > type(uint192).max) return true;
return amount1 < (amount0 << 64);
}
/**
* @dev A Q128 quotient covers V4's remaining representable price range.
*/
function _fitsQ128(uint256 amount0, uint256 amount1) private pure returns (bool) {
if (amount0 > type(uint128).max) return true;
return amount1 < (amount0 << 128);
}
}
contracts/lib/v4-core/src/libraries/SqrtPriceMath.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {SafeCast} from "./SafeCast.sol";
import {FullMath} from "./FullMath.sol";
import {UnsafeMath} from "./UnsafeMath.sol";
import {FixedPoint96} from "./FixedPoint96.sol";
/// @title Functions based on Q64.96 sqrt price and liquidity
/// @notice Contains the math that uses square root of price as a Q64.96 and liquidity to compute deltas
library SqrtPriceMath {
using SafeCast for uint256;
error InvalidPriceOrLiquidity();
error InvalidPrice();
error NotEnoughLiquidity();
error PriceOverflow();
/// @notice Gets the next sqrt price given a delta of currency0
/// @dev Always rounds up, because in the exact output case (increasing price) we need to move the price at least
/// far enough to get the desired output amount, and in the exact input case (decreasing price) we need to move the
/// price less in order to not send too much output.
/// The most precise formula for this is liquidity * sqrtPX96 / (liquidity +- amount * sqrtPX96),
/// if this is impossible because of overflow, we calculate liquidity / (liquidity / sqrtPX96 +- amount).
/// @param sqrtPX96 The starting price, i.e. before accounting for the currency0 delta
/// @param liquidity The amount of usable liquidity
/// @param amount How much of currency0 to add or remove from virtual reserves
/// @param add Whether to add or remove the amount of currency0
/// @return The price after adding or removing amount, depending on add
function getNextSqrtPriceFromAmount0RoundingUp(uint160 sqrtPX96, uint128 liquidity, uint256 amount, bool add)
internal
pure
returns (uint160)
{
// we short circuit amount == 0 because the result is otherwise not guaranteed to equal the input price
if (amount == 0) return sqrtPX96;
uint256 numerator1 = uint256(liquidity) << FixedPoint96.RESOLUTION;
if (add) {
unchecked {
uint256 product = amount * sqrtPX96;
if (product / amount == sqrtPX96) {
uint256 denominator = numerator1 + product;
if (denominator >= numerator1) {
// always fits in 160 bits
return uint160(FullMath.mulDivRoundingUp(numerator1, sqrtPX96, denominator));
}
}
}
// denominator is checked for overflow
return uint160(UnsafeMath.divRoundingUp(numerator1, (numerator1 / sqrtPX96) + amount));
} else {
unchecked {
uint256 product = amount * sqrtPX96;
// if the product overflows, we know the denominator underflows
// in addition, we must check that the denominator does not underflow
// equivalent: if (product / amount != sqrtPX96 || numerator1 <= product) revert PriceOverflow();
assembly ("memory-safe") {
if iszero(
and(
eq(div(product, amount), and(sqrtPX96, 0xffffffffffffffffffffffffffffffffffffffff)),
gt(numerator1, product)
)
) {
mstore(0, 0xf5c787f1) // selector for PriceOverflow()
revert(0x1c, 0x04)
}
}
uint256 denominator = numerator1 - product;
return FullMath.mulDivRoundingUp(numerator1, sqrtPX96, denominator).toUint160();
}
}
}
/// @notice Gets the next sqrt price given a delta of currency1
/// @dev Always rounds down, because in the exact output case (decreasing price) we need to move the price at least
/// far enough to get the desired output amount, and in the exact input case (increasing price) we need to move the
/// price less in order to not send too much output.
/// The formula we compute is within <1 wei of the lossless version: sqrtPX96 +- amount / liquidity
/// @param sqrtPX96 The starting price, i.e., before accounting for the currency1 delta
/// @param liquidity The amount of usable liquidity
/// @param amount How much of currency1 to add, or remove, from virtual reserves
/// @param add Whether to add, or remove, the amount of currency1
/// @return The price after adding or removing `amount`
function getNextSqrtPriceFromAmount1RoundingDown(uint160 sqrtPX96, uint128 liquidity, uint256 amount, bool add)
internal
pure
returns (uint160)
{
// if we're adding (subtracting), rounding down requires rounding the quotient down (up)
// in both cases, avoid a mulDiv for most inputs
if (add) {
uint256 quotient = (
amount <= type(uint160).max
? (amount << FixedPoint96.RESOLUTION) / liquidity
: FullMath.mulDiv(amount, FixedPoint96.Q96, liquidity)
);
return (uint256(sqrtPX96) + quotient).toUint160();
} else {
uint256 quotient = (
amount <= type(uint160).max
? UnsafeMath.divRoundingUp(amount << FixedPoint96.RESOLUTION, liquidity)
: FullMath.mulDivRoundingUp(amount, FixedPoint96.Q96, liquidity)
);
// equivalent: if (sqrtPX96 <= quotient) revert NotEnoughLiquidity();
assembly ("memory-safe") {
if iszero(gt(and(sqrtPX96, 0xffffffffffffffffffffffffffffffffffffffff), quotient)) {
mstore(0, 0x4323a555) // selector for NotEnoughLiquidity()
revert(0x1c, 0x04)
}
}
// always fits 160 bits
unchecked {
return uint160(sqrtPX96 - quotient);
}
}
}
/// @notice Gets the next sqrt price given an input amount of currency0 or currency1
/// @dev Throws if price or liquidity are 0, or if the next price is out of bounds
/// @param sqrtPX96 The starting price, i.e., before accounting for the input amount
/// @param liquidity The amount of usable liquidity
/// @param amountIn How much of currency0, or currency1, is being swapped in
/// @param zeroForOne Whether the amount in is currency0 or currency1
/// @return uint160 The price after adding the input amount to currency0 or currency1
function getNextSqrtPriceFromInput(uint160 sqrtPX96, uint128 liquidity, uint256 amountIn, bool zeroForOne)
internal
pure
returns (uint160)
{
// equivalent: if (sqrtPX96 == 0 || liquidity == 0) revert InvalidPriceOrLiquidity();
assembly ("memory-safe") {
if or(
iszero(and(sqrtPX96, 0xffffffffffffffffffffffffffffffffffffffff)),
iszero(and(liquidity, 0xffffffffffffffffffffffffffffffff))
) {
mstore(0, 0x4f2461b8) // selector for InvalidPriceOrLiquidity()
revert(0x1c, 0x04)
}
}
// round to make sure that we don't pass the target price
return zeroForOne
? getNextSqrtPriceFromAmount0RoundingUp(sqrtPX96, liquidity, amountIn, true)
: getNextSqrtPriceFromAmount1RoundingDown(sqrtPX96, liquidity, amountIn, true);
}
/// @notice Gets the next sqrt price given an output amount of currency0 or currency1
/// @dev Throws if price or liquidity are 0 or the next price is out of bounds
/// @param sqrtPX96 The starting price before accounting for the output amount
/// @param liquidity The amount of usable liquidity
/// @param amountOut How much of currency0, or currency1, is being swapped out
/// @param zeroForOne Whether the amount out is currency1 or currency0
/// @return uint160 The price after removing the output amount of currency0 or currency1
function getNextSqrtPriceFromOutput(uint160 sqrtPX96, uint128 liquidity, uint256 amountOut, bool zeroForOne)
internal
pure
returns (uint160)
{
// equivalent: if (sqrtPX96 == 0 || liquidity == 0) revert InvalidPriceOrLiquidity();
assembly ("memory-safe") {
if or(
iszero(and(sqrtPX96, 0xffffffffffffffffffffffffffffffffffffffff)),
iszero(and(liquidity, 0xffffffffffffffffffffffffffffffff))
) {
mstore(0, 0x4f2461b8) // selector for InvalidPriceOrLiquidity()
revert(0x1c, 0x04)
}
}
// round to make sure that we pass the target price
return zeroForOne
? getNextSqrtPriceFromAmount1RoundingDown(sqrtPX96, liquidity, amountOut, false)
: getNextSqrtPriceFromAmount0RoundingUp(sqrtPX96, liquidity, amountOut, false);
}
/// @notice Gets the amount0 delta between two prices
/// @dev Calculates liquidity / sqrt(lower) - liquidity / sqrt(upper),
/// i.e. liquidity * (sqrt(upper) - sqrt(lower)) / (sqrt(upper) * sqrt(lower))
/// @param sqrtPriceAX96 A sqrt price
/// @param sqrtPriceBX96 Another sqrt price
/// @param liquidity The amount of usable liquidity
/// @param roundUp Whether to round the amount up or down
/// @return uint256 Amount of currency0 required to cover a position of size liquidity between the two passed prices
function getAmount0Delta(uint160 sqrtPriceAX96, uint160 sqrtPriceBX96, uint128 liquidity, bool roundUp)
internal
pure
returns (uint256)
{
unchecked {
if (sqrtPriceAX96 > sqrtPriceBX96) (sqrtPriceAX96, sqrtPriceBX96) = (sqrtPriceBX96, sqrtPriceAX96);
// equivalent: if (sqrtPriceAX96 == 0) revert InvalidPrice();
assembly ("memory-safe") {
if iszero(and(sqrtPriceAX96, 0xffffffffffffffffffffffffffffffffffffffff)) {
mstore(0, 0x00bfc921) // selector for InvalidPrice()
revert(0x1c, 0x04)
}
}
uint256 numerator1 = uint256(liquidity) << FixedPoint96.RESOLUTION;
uint256 numerator2 = sqrtPriceBX96 - sqrtPriceAX96;
return roundUp
? UnsafeMath.divRoundingUp(FullMath.mulDivRoundingUp(numerator1, numerator2, sqrtPriceBX96), sqrtPriceAX96)
: FullMath.mulDiv(numerator1, numerator2, sqrtPriceBX96) / sqrtPriceAX96;
}
}
/// @notice Equivalent to: `a >= b ? a - b : b - a`
function absDiff(uint160 a, uint160 b) internal pure returns (uint256 res) {
assembly ("memory-safe") {
let diff :=
sub(and(a, 0xffffffffffffffffffffffffffffffffffffffff), and(b, 0xffffffffffffffffffffffffffffffffffffffff))
// mask = 0 if a >= b else -1 (all 1s)
let mask := sar(255, diff)
// if a >= b, res = a - b = 0 ^ (a - b)
// if a < b, res = b - a = ~~(b - a) = ~(-(b - a) - 1) = ~(a - b - 1) = (-1) ^ (a - b - 1)
// either way, res = mask ^ (a - b + mask)
res := xor(mask, add(mask, diff))
}
}
/// @notice Gets the amount1 delta between two prices
/// @dev Calculates liquidity * (sqrt(upper) - sqrt(lower))
/// @param sqrtPriceAX96 A sqrt price
/// @param sqrtPriceBX96 Another sqrt price
/// @param liquidity The amount of usable liquidity
/// @param roundUp Whether to round the amount up, or down
/// @return amount1 Amount of currency1 required to cover a position of size liquidity between the two passed prices
function getAmount1Delta(uint160 sqrtPriceAX96, uint160 sqrtPriceBX96, uint128 liquidity, bool roundUp)
internal
pure
returns (uint256 amount1)
{
uint256 numerator = absDiff(sqrtPriceAX96, sqrtPriceBX96);
uint256 denominator = FixedPoint96.Q96;
uint256 _liquidity = uint256(liquidity);
/**
* Equivalent to:
* amount1 = roundUp
* ? FullMath.mulDivRoundingUp(liquidity, sqrtPriceBX96 - sqrtPriceAX96, FixedPoint96.Q96)
* : FullMath.mulDiv(liquidity, sqrtPriceBX96 - sqrtPriceAX96, FixedPoint96.Q96);
* Cannot overflow because `type(uint128).max * type(uint160).max >> 96 < (1 << 192)`.
*/
amount1 = FullMath.mulDiv(_liquidity, numerator, denominator);
assembly ("memory-safe") {
amount1 := add(amount1, and(gt(mulmod(_liquidity, numerator, denominator), 0), roundUp))
}
}
/// @notice Helper that gets signed currency0 delta
/// @param sqrtPriceAX96 A sqrt price
/// @param sqrtPriceBX96 Another sqrt price
/// @param liquidity The change in liquidity for which to compute the amount0 delta
/// @return int256 Amount of currency0 corresponding to the passed liquidityDelta between the two prices
function getAmount0Delta(uint160 sqrtPriceAX96, uint160 sqrtPriceBX96, int128 liquidity)
internal
pure
returns (int256)
{
unchecked {
return liquidity < 0
? getAmount0Delta(sqrtPriceAX96, sqrtPriceBX96, uint128(-liquidity), false).toInt256()
: -getAmount0Delta(sqrtPriceAX96, sqrtPriceBX96, uint128(liquidity), true).toInt256();
}
}
/// @notice Helper that gets signed currency1 delta
/// @param sqrtPriceAX96 A sqrt price
/// @param sqrtPriceBX96 Another sqrt price
/// @param liquidity The change in liquidity for which to compute the amount1 delta
/// @return int256 Amount of currency1 corresponding to the passed liquidityDelta between the two prices
function getAmount1Delta(uint160 sqrtPriceAX96, uint160 sqrtPriceBX96, int128 liquidity)
internal
pure
returns (int256)
{
unchecked {
return liquidity < 0
? getAmount1Delta(sqrtPriceAX96, sqrtPriceBX96, uint128(-liquidity), false).toInt256()
: -getAmount1Delta(sqrtPriceAX96, sqrtPriceBX96, uint128(liquidity), true).toInt256();
}
}
}
contracts/lib/v4-core/src/libraries/LiquidityMath.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title Math library for liquidity
library LiquidityMath {
/// @notice Add a signed liquidity delta to liquidity and revert if it overflows or underflows
/// @param x The liquidity before change
/// @param y The delta by which liquidity should be changed
/// @return z The liquidity delta
function addDelta(uint128 x, int128 y) internal pure returns (uint128 z) {
assembly ("memory-safe") {
z := add(and(x, 0xffffffffffffffffffffffffffffffff), signextend(15, y))
if shr(128, z) {
// revert SafeCastOverflow()
mstore(0, 0x93dafdf1)
revert(0x1c, 0x04)
}
}
}
}
contracts/lib/openzeppelin-contracts/contracts/token/ERC20/ERC20.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC20Metadata} from "./extensions/IERC20Metadata.sol";
import {Context} from "../../utils/Context.sol";
import {IERC20Errors} from "../../interfaces/draft-IERC6093.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC-20
* applications.
*/
abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors {
mapping(address account => uint256) private _balances;
mapping(address account => mapping(address spender => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* Both values are immutable: they can only be set once during construction.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual returns (string memory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the default value returned by this function, unless
* it's overridden.
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual returns (uint8) {
return 18;
}
/// @inheritdoc IERC20
function totalSupply() public view virtual returns (uint256) {
return _totalSupply;
}
/// @inheritdoc IERC20
function balanceOf(address account) public view virtual returns (uint256) {
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `value`.
*/
function transfer(address to, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_transfer(owner, to, value);
return true;
}
/// @inheritdoc IERC20
function allowance(address owner, address spender) public view virtual returns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `value` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, value);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Skips emitting an {Approval} event indicating an allowance update. This is not
* required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `value`.
* - the caller must have allowance for ``from``'s tokens of at least
* `value`.
*/
function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, value);
_transfer(from, to, value);
return true;
}
/**
* @dev Moves a `value` amount of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _transfer(address from, address to, uint256 value) internal {
if (from == address(0)) {
revert ERC20InvalidSender(address(0));
}
if (to == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(from, to, value);
}
/**
* @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
* (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding
* this function.
*
* Emits a {Transfer} event.
*/
function _update(address from, address to, uint256 value) internal virtual {
if (from == address(0)) {
// Overflow check required: The rest of the code assumes that totalSupply never overflows
_totalSupply += value;
} else {
uint256 fromBalance = _balances[from];
if (fromBalance < value) {
revert ERC20InsufficientBalance(from, fromBalance, value);
}
unchecked {
// Overflow not possible: value <= fromBalance <= totalSupply.
_balances[from] = fromBalance - value;
}
}
if (to == address(0)) {
unchecked {
// Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply.
_totalSupply -= value;
}
} else {
unchecked {
// Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256.
_balances[to] += value;
}
}
emit Transfer(from, to, value);
}
/**
* @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
* Relies on the `_update` mechanism
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _mint(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(address(0), account, value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
* Relies on the `_update` mechanism.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead
*/
function _burn(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidSender(address(0));
}
_update(account, address(0), value);
}
/**
* @dev Sets `value` as the allowance of `spender` over the `owner`'s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/
function _approve(address owner, address spender, uint256 value) internal {
_approve(owner, spender, value, true);
}
/**
* @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event.
*
* By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by
* `_spendAllowance` during the `transferFrom` operation sets the flag to false. This saves gas by not emitting any
* `Approval` event during `transferFrom` operations.
*
* Anyone who wishes to continue emitting `Approval` events on the `transferFrom` operation can force the flag to
* true using the following override:
*
* ```solidity
* function _approve(address owner, address spender, uint256 value, bool) internal virtual override {
* super._approve(owner, spender, value, true);
* }
* ```
*
* Requirements are the same as {_approve}.
*/
function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual {
if (owner == address(0)) {
revert ERC20InvalidApprover(address(0));
}
if (spender == address(0)) {
revert ERC20InvalidSpender(address(0));
}
_allowances[owner][spender] = value;
if (emitEvent) {
emit Approval(owner, spender, value);
}
}
/**
* @dev Updates `owner`'s allowance for `spender` based on spent `value`.
*
* Does not update the allowance value in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Does not emit an {Approval} event.
*/
function _spendAllowance(address owner, address spender, uint256 value) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance < type(uint256).max) {
if (currentAllowance < value) {
revert ERC20InsufficientAllowance(spender, currentAllowance, value);
}
unchecked {
_approve(owner, spender, currentAllowance - value, false);
}
}
}
}
contracts/lib/openzeppelin-contracts/contracts/utils/introspection/IERC165.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/introspection/IERC165.sol)
pragma solidity >=0.4.16;
/**
* @dev Interface of the ERC-165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[ERC].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[ERC section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
contracts/lib/openzeppelin-contracts/contracts/utils/ReentrancyGuard.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (utils/ReentrancyGuard.sol)
pragma solidity ^0.8.20;
import {StorageSlot} from "./StorageSlot.sol";
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If EIP-1153 (transient storage) is available on the chain you're deploying at,
* consider using {ReentrancyGuardTransient} instead.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*
* IMPORTANT: Deprecated. This storage-based reentrancy guard will be removed and replaced
* by the {ReentrancyGuardTransient} variant in v6.0.
*
* @custom:stateless
*/
abstract contract ReentrancyGuard {
using StorageSlot for bytes32;
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ReentrancyGuard")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant REENTRANCY_GUARD_STORAGE =
0x9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f00;
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant NOT_ENTERED = 1;
uint256 private constant ENTERED = 2;
/**
* @dev Unauthorized reentrant call.
*/
error ReentrancyGuardReentrantCall();
constructor() {
_reentrancyGuardStorageSlot().getUint256Slot().value = NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
/**
* @dev A `view` only version of {nonReentrant}. Use to block view functions
* from being called, preventing reading from inconsistent contract state.
*
* CAUTION: This is a "view" modifier and does not change the reentrancy
* status. Use it only on view functions. For payable or non-payable functions,
* use the standard {nonReentrant} modifier instead.
*/
modifier nonReentrantView() {
_nonReentrantBeforeView();
_;
}
function _nonReentrantBeforeView() private view {
if (_reentrancyGuardEntered()) {
revert ReentrancyGuardReentrantCall();
}
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be NOT_ENTERED
_nonReentrantBeforeView();
// Any calls to nonReentrant after this point will fail
_reentrancyGuardStorageSlot().getUint256Slot().value = ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_reentrancyGuardStorageSlot().getUint256Slot().value = NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _reentrancyGuardStorageSlot().getUint256Slot().value == ENTERED;
}
function _reentrancyGuardStorageSlot() internal pure virtual returns (bytes32) {
return REENTRANCY_GUARD_STORAGE;
}
}
contracts/lib/v4-periphery/src/libraries/Actions.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @notice Library to define different pool actions.
/// @dev These are suggested common commands, however additional commands should be defined as required
/// Some of these actions are not supported in the Router contracts or Position Manager contracts, but are left as they may be helpful commands for other peripheral contracts.
library Actions {
// pool actions
// liquidity actions
uint256 internal constant INCREASE_LIQUIDITY = 0x00;
uint256 internal constant DECREASE_LIQUIDITY = 0x01;
uint256 internal constant MINT_POSITION = 0x02;
uint256 internal constant BURN_POSITION = 0x03;
/// @notice DEPRECATED: Vulnerable to sandwich attacks - do not use.
/// @dev The delta-based approach lacks minimum liquidity slippage protection, allowing
/// attackers to manipulate the price and reduce the liquidity received.
/// Use INCREASE_LIQUIDITY instead.
uint256 internal constant INCREASE_LIQUIDITY_FROM_DELTAS = 0x04;
/// @notice DEPRECATED: Vulnerable to sandwich attacks - do not use.
/// @dev The delta-based approach lacks minimum liquidity slippage protection, allowing
/// attackers to manipulate the price and reduce the liquidity received.
/// Use MINT_POSITION instead.
uint256 internal constant MINT_POSITION_FROM_DELTAS = 0x05;
// swapping
uint256 internal constant SWAP_EXACT_IN_SINGLE = 0x06;
uint256 internal constant SWAP_EXACT_IN = 0x07;
uint256 internal constant SWAP_EXACT_OUT_SINGLE = 0x08;
uint256 internal constant SWAP_EXACT_OUT = 0x09;
// donate
// note this is not supported in the position manager or router
uint256 internal constant DONATE = 0x0a;
// closing deltas on the pool manager
// settling
uint256 internal constant SETTLE = 0x0b;
uint256 internal constant SETTLE_ALL = 0x0c;
uint256 internal constant SETTLE_PAIR = 0x0d;
// taking
uint256 internal constant TAKE = 0x0e;
uint256 internal constant TAKE_ALL = 0x0f;
uint256 internal constant TAKE_PORTION = 0x10;
uint256 internal constant TAKE_PAIR = 0x11;
uint256 internal constant CLOSE_CURRENCY = 0x12;
uint256 internal constant CLEAR_OR_TAKE = 0x13;
uint256 internal constant SWEEP = 0x14;
uint256 internal constant WRAP = 0x15;
uint256 internal constant UNWRAP = 0x16;
// minting/burning 6909s to close deltas
// note this is not supported in the position manager or router
uint256 internal constant MINT_6909 = 0x17;
uint256 internal constant BURN_6909 = 0x18;
// permissioned-pools specific actions
// routes a currency's positive delta with a fallback cascade: LP → defaultRecipient → 6909 mint to defaultRecipient
uint256 internal constant UNWIND_WITH_FALLBACK = 0x19;
// subscribing/unsubscribing via position manager
uint256 internal constant SUBSCRIBE = 0x1a;
uint256 internal constant UNSUBSCRIBE = 0x1b;
}
contracts/lib/v4-core/src/types/BalanceDelta.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {SafeCast} from "../libraries/SafeCast.sol";
/// @dev Two `int128` values packed into a single `int256` where the upper 128 bits represent the amount0
/// and the lower 128 bits represent the amount1.
type BalanceDelta is int256;
using {add as +, sub as -, eq as ==, neq as !=} for BalanceDelta global;
using BalanceDeltaLibrary for BalanceDelta global;
using SafeCast for int256;
function toBalanceDelta(int128 _amount0, int128 _amount1) pure returns (BalanceDelta balanceDelta) {
assembly ("memory-safe") {
balanceDelta := or(shl(128, _amount0), and(sub(shl(128, 1), 1), _amount1))
}
}
function add(BalanceDelta a, BalanceDelta b) pure returns (BalanceDelta) {
int256 res0;
int256 res1;
assembly ("memory-safe") {
let a0 := sar(128, a)
let a1 := signextend(15, a)
let b0 := sar(128, b)
let b1 := signextend(15, b)
res0 := add(a0, b0)
res1 := add(a1, b1)
}
return toBalanceDelta(res0.toInt128(), res1.toInt128());
}
function sub(BalanceDelta a, BalanceDelta b) pure returns (BalanceDelta) {
int256 res0;
int256 res1;
assembly ("memory-safe") {
let a0 := sar(128, a)
let a1 := signextend(15, a)
let b0 := sar(128, b)
let b1 := signextend(15, b)
res0 := sub(a0, b0)
res1 := sub(a1, b1)
}
return toBalanceDelta(res0.toInt128(), res1.toInt128());
}
function eq(BalanceDelta a, BalanceDelta b) pure returns (bool) {
return BalanceDelta.unwrap(a) == BalanceDelta.unwrap(b);
}
function neq(BalanceDelta a, BalanceDelta b) pure returns (bool) {
return BalanceDelta.unwrap(a) != BalanceDelta.unwrap(b);
}
/// @notice Library for getting the amount0 and amount1 deltas from the BalanceDelta type
library BalanceDeltaLibrary {
/// @notice A BalanceDelta of 0
BalanceDelta public constant ZERO_DELTA = BalanceDelta.wrap(0);
function amount0(BalanceDelta balanceDelta) internal pure returns (int128 _amount0) {
assembly ("memory-safe") {
_amount0 := sar(128, balanceDelta)
}
}
function amount1(BalanceDelta balanceDelta) internal pure returns (int128 _amount1) {
assembly ("memory-safe") {
_amount1 := signextend(15, balanceDelta)
}
}
}
contracts/lib/v4-periphery/src/libraries/PositionInfoLibrary.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
import {PoolId} from "@uniswap/v4-core/src/types/PoolId.sol";
/**
* @dev PositionInfo is a packed version of solidity structure.
* Using the packaged version saves gas and memory by not storing the structure fields in memory slots.
*
* Layout:
* 200 bits poolId | 24 bits tickUpper | 24 bits tickLower | 8 bits hasSubscriber
*
* Fields in the direction from the least significant bit:
*
* A flag to know if the tokenId is subscribed to an address
* uint8 hasSubscriber;
*
* The tickUpper of the position
* int24 tickUpper;
*
* The tickLower of the position
* int24 tickLower;
*
* The truncated poolId. Truncates a bytes32 value so the most signifcant (highest) 200 bits are used.
* bytes25 poolId;
*
* Note: If more bits are needed, hasSubscriber can be a single bit.
*
*/
type PositionInfo is uint256;
using PositionInfoLibrary for PositionInfo global;
library PositionInfoLibrary {
PositionInfo internal constant EMPTY_POSITION_INFO = PositionInfo.wrap(0);
uint256 internal constant MASK_UPPER_200_BITS = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF00000000000000;
uint256 internal constant MASK_8_BITS = 0xFF;
uint24 internal constant MASK_24_BITS = 0xFFFFFF;
uint256 internal constant SET_UNSUBSCRIBE = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF00;
uint256 internal constant SET_SUBSCRIBE = 0x01;
uint8 internal constant TICK_LOWER_OFFSET = 8;
uint8 internal constant TICK_UPPER_OFFSET = 32;
/// @dev This poolId is NOT compatible with the poolId used in UniswapV4 core. It is truncated to 25 bytes, and just used to lookup PoolKey in the poolKeys mapping.
function poolId(PositionInfo info) internal pure returns (bytes25 _poolId) {
assembly ("memory-safe") {
_poolId := and(MASK_UPPER_200_BITS, info)
}
}
function tickLower(PositionInfo info) internal pure returns (int24 _tickLower) {
assembly ("memory-safe") {
_tickLower := signextend(2, shr(TICK_LOWER_OFFSET, info))
}
}
function tickUpper(PositionInfo info) internal pure returns (int24 _tickUpper) {
assembly ("memory-safe") {
_tickUpper := signextend(2, shr(TICK_UPPER_OFFSET, info))
}
}
function hasSubscriber(PositionInfo info) internal pure returns (bool _hasSubscriber) {
assembly ("memory-safe") {
_hasSubscriber := and(MASK_8_BITS, info)
}
}
/// @dev this does not actually set any storage
function setSubscribe(PositionInfo info) internal pure returns (PositionInfo _info) {
assembly ("memory-safe") {
_info := or(info, SET_SUBSCRIBE)
}
}
/// @dev this does not actually set any storage
function setUnsubscribe(PositionInfo info) internal pure returns (PositionInfo _info) {
assembly ("memory-safe") {
_info := and(info, SET_UNSUBSCRIBE)
}
}
/// @notice Creates the default PositionInfo struct
/// @dev Called when minting a new position
/// @param _poolKey the pool key of the position
/// @param _tickLower the lower tick of the position
/// @param _tickUpper the upper tick of the position
/// @return info packed position info, with the truncated poolId and the hasSubscriber flag set to false
function initialize(PoolKey memory _poolKey, int24 _tickLower, int24 _tickUpper)
internal
pure
returns (PositionInfo info)
{
bytes25 _poolId = bytes25(PoolId.unwrap(_poolKey.toId()));
assembly {
info := or(
or(and(MASK_UPPER_200_BITS, _poolId), shl(TICK_UPPER_OFFSET, and(MASK_24_BITS, _tickUpper))),
shl(TICK_LOWER_OFFSET, and(MASK_24_BITS, _tickLower))
)
}
}
}
contracts/lib/v4-core/src/libraries/CustomRevert.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title Library for reverting with custom errors efficiently
/// @notice Contains functions for reverting with custom errors with different argument types efficiently
/// @dev To use this library, declare `using CustomRevert for bytes4;` and replace `revert CustomError()` with
/// `CustomError.selector.revertWith()`
/// @dev The functions may tamper with the free memory pointer but it is fine since the call context is exited immediately
library CustomRevert {
/// @dev ERC-7751 error for wrapping bubbled up reverts
error WrappedError(address target, bytes4 selector, bytes reason, bytes details);
/// @dev Reverts with the selector of a custom error in the scratch space
function revertWith(bytes4 selector) internal pure {
assembly ("memory-safe") {
mstore(0, selector)
revert(0, 0x04)
}
}
/// @dev Reverts with a custom error with an address argument in the scratch space
function revertWith(bytes4 selector, address addr) internal pure {
assembly ("memory-safe") {
mstore(0, selector)
mstore(0x04, and(addr, 0xffffffffffffffffffffffffffffffffffffffff))
revert(0, 0x24)
}
}
/// @dev Reverts with a custom error with an int24 argument in the scratch space
function revertWith(bytes4 selector, int24 value) internal pure {
assembly ("memory-safe") {
mstore(0, selector)
mstore(0x04, signextend(2, value))
revert(0, 0x24)
}
}
/// @dev Reverts with a custom error with a uint160 argument in the scratch space
function revertWith(bytes4 selector, uint160 value) internal pure {
assembly ("memory-safe") {
mstore(0, selector)
mstore(0x04, and(value, 0xffffffffffffffffffffffffffffffffffffffff))
revert(0, 0x24)
}
}
/// @dev Reverts with a custom error with two int24 arguments
function revertWith(bytes4 selector, int24 value1, int24 value2) internal pure {
assembly ("memory-safe") {
let fmp := mload(0x40)
mstore(fmp, selector)
mstore(add(fmp, 0x04), signextend(2, value1))
mstore(add(fmp, 0x24), signextend(2, value2))
revert(fmp, 0x44)
}
}
/// @dev Reverts with a custom error with two uint160 arguments
function revertWith(bytes4 selector, uint160 value1, uint160 value2) internal pure {
assembly ("memory-safe") {
let fmp := mload(0x40)
mstore(fmp, selector)
mstore(add(fmp, 0x04), and(value1, 0xffffffffffffffffffffffffffffffffffffffff))
mstore(add(fmp, 0x24), and(value2, 0xffffffffffffffffffffffffffffffffffffffff))
revert(fmp, 0x44)
}
}
/// @dev Reverts with a custom error with two address arguments
function revertWith(bytes4 selector, address value1, address value2) internal pure {
assembly ("memory-safe") {
let fmp := mload(0x40)
mstore(fmp, selector)
mstore(add(fmp, 0x04), and(value1, 0xffffffffffffffffffffffffffffffffffffffff))
mstore(add(fmp, 0x24), and(value2, 0xffffffffffffffffffffffffffffffffffffffff))
revert(fmp, 0x44)
}
}
/// @notice bubble up the revert message returned by a call and revert with a wrapped ERC-7751 error
/// @dev this method can be vulnerable to revert data bombs
function bubbleUpAndRevertWith(
address revertingContract,
bytes4 revertingFunctionSelector,
bytes4 additionalContext
) internal pure {
bytes4 wrappedErrorSelector = WrappedError.selector;
assembly ("memory-safe") {
// Ensure the size of the revert data is a multiple of 32 bytes
let encodedDataSize := mul(div(add(returndatasize(), 31), 32), 32)
let fmp := mload(0x40)
// Encode wrapped error selector, address, function selector, offset, additional context, size, revert reason
mstore(fmp, wrappedErrorSelector)
mstore(add(fmp, 0x04), and(revertingContract, 0xffffffffffffffffffffffffffffffffffffffff))
mstore(
add(fmp, 0x24),
and(revertingFunctionSelector, 0xffffffff00000000000000000000000000000000000000000000000000000000)
)
// offset revert reason
mstore(add(fmp, 0x44), 0x80)
// offset additional context
mstore(add(fmp, 0x64), add(0xa0, encodedDataSize))
// size revert reason
mstore(add(fmp, 0x84), returndatasize())
// revert reason
returndatacopy(add(fmp, 0xa4), 0, returndatasize())
// size additional context
mstore(add(fmp, add(0xa4, encodedDataSize)), 0x04)
// additional context
mstore(
add(fmp, add(0xc4, encodedDataSize)),
and(additionalContext, 0xffffffff00000000000000000000000000000000000000000000000000000000)
)
revert(fmp, add(0xe4, encodedDataSize))
}
}
}
contracts/lib/v4-periphery/src/interfaces/IUnorderedNonce.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title IUnorderedNonce
/// @notice Interface for the UnorderedNonce contract
interface IUnorderedNonce {
error NonceAlreadyUsed();
/// @notice mapping of nonces consumed by each address, where a nonce is a single bit on the 256-bit bitmap
/// @dev word is at most type(uint248).max
function nonces(address owner, uint256 word) external view returns (uint256);
/// @notice Revoke a nonce by spending it, preventing it from being used again
/// @dev Used in cases where a valid nonce has not been broadcasted onchain, and the owner wants to revoke the validity of the nonce
/// @dev payable so it can be multicalled with native-token related actions
function revokeNonce(uint256 nonce) external payable;
}