Clanker v5

​

Contracts

​

Factory

​

Launch functions

// Deploys a token and its pool. msg.value must equal nativeLaunchFee().
function createLaunch(LaunchParams calldata launchParams)
    external payable returns (address token, bytes32 poolId);

// Deploys a token and makes a first buy in the same transaction.
function createLaunchAndBuy(LaunchParams calldata launchParams, LaunchBuyParams calldata launchBuyParams)
    external payable returns (address token, bytes32 poolId, uint256 amountOut);

// Returns the rates that a tax configuration gives under the current policy, and whether it enables dividends.
function previewTaxConfiguration(TaxConfiguration calldata configuration)
    external view returns (TaxConfigurationPreview memory);

• expectedConfigVersion must equal configVersion(). Any change to the launch settings increases the version, so a launch signed under older settings reverts with StaleConfig.
• taxConfiguration sets buyTaxRate and sellTaxRate, and the split of the tax after the Clanker fee: creatorAllocationShare, burnAllocationShare, dividendAllocationShare and integratorAllocationShare, which must add up to 100%. It also sets minimumDividendHolding. All rates and shares use a scale of 1e8 = 100%.
• The reward recipients’ weights (relativeWeightBps) must add up to 10,000. One recipient can be marked as the creator’s slot, which follows the creator rights.

​

Creator functions

​

Read functions

​

Factory events

​

Hook

• Tax: on every swap, the hook takes the buy or sell tax. The Clanker fee, creator, dividend and integrator shares are taken in the quote currency and credited in the FeeEscrow. The burn share is taken in the launched token and credited in the FeeEscrow to the dead address 0x000000000000000000000000000000000000dEaD.
• Locked liquidity: the hook places the launch liquidity itself and blocks every liquidity add and removal, so the liquidity can never be removed.
• Frozen terms: each pool keeps the tax, split and policy it launched with. Later policy changes apply only to new launches.
• Sniper fee: on a launch with the sniper fee on, the total fee starts at the policy’s starting rate and falls linearly to the normal tax over the sniper window. The extra fee goes to Clanker. Exact-output swaps revert during the window.
• No eligible holders: when a trade’s dividend share finds no eligible holder, it is credited to the Clanker fee recipient.

​

Hook functions

​

Integrator consent

​

Hook events

​

FeeEscrow

// Callable by anyone. Pays the recipient's whole balance in `currency` to the recipient.
function claimFor(address recipient, address currency) external;

// Pays the caller's whole balance in `currency` to `destination`.
function claimTo(address currency, address destination) external;

// The claimable balance of a recipient in a currency.
function owed(address recipient, address currency) external view returns (uint256);

​

Dividend Deployer

​

Dividend Claim Helper

struct Claim {
    address token;
    bool unwrapWrappedNative; // pay the native coin instead of its wrapped token for a native pair
}

// Up to 64 tokens per call. Each token appears once.
function claimDividends(Claim[] calldata claims) external returns (uint256 paidCount, bool[] memory paid);

​

Announcement Registry

function postAnnouncement(address token, bytes32 announcementId, string calldata description, string calldata announcementURI) external;

​

Supporting contracts

• Launch Validation: checks each launch against the current launch policy before the factory deploys it.
• Launch Operations: a library the factory uses for launch logic.
• Launch Buy Adapter: runs the creator buy in createLaunchAndBuy.
• Token Deployer: deploys each v5 token contract for the factory.
• Dividend Implementation: the template each token’s dividend contract is created from by the Dividend Deployer.

​

External contracts

• PoolManager: holds every v5 pool. The factory and the hook return it from poolManager().
• Quoter and StateView: read quotes and pool state off chain.
• Universal Router and Permit2: the usual way to swap in a Uniswap v4 pool.
• WETH and USDC: the pair tokens. A v5 ETH pool pairs with native ETH (the zero address); pass WETH in the deploy API.

​

Launch policy

​

Administrative permissions

​

Factory

• Sets the launch policy for new launches: setTaxPolicy(), setTaxFeeBounds(), setProtocolFeeConfiguration(), setAntiSnipeConfiguration(), setMinimumDividendHoldingRequirement().
• Opens or pauses new launches with setLaunchCreationEnabled().
• Adds and removes quote tokens with registerQuote(), unregisterQuote() and their batch forms.
• Sets the starting price of a quote token with setQuoteStartTick(), and sets the price updater with setPriceUpdater().
• Changes the supply, pool layout and launch fee of new launches: setLaunchSupply(), setTickSpacing(), setBandTemplate(), setNativeLaunchFee().
• Sets the adapter used by createLaunchAndBuy with setLaunchBuyAdapter().
• Sets the default dividend exclusions of new launches with setDefaultDividendExclusion().
• Sets the Announcement Registry once with setAnnouncementRegistry().
• Appoints and removes the creator admin: transferCreatorAdmin(), cancelCreatorAdminTransfer(), revokeCreatorAdmin().

• Excludes or re-includes holders with setLaunchDividendExclusions().
• Sets the address that receives a holder’s dividends with setLaunchDividendReceiver().
• Updates holders’ recorded balances with refreshLaunchDividendShares().
• Withdraws assets held by the dividend contract with emergencyWithdrawDividendAssets().

• Updates the starting price of a registered quote token for new launches with setQuoteStartTick() and batchSetQuoteStartTicks().

• Updates the token’s metadata, if it launched with metadataEditable on.
• Changes the creator’s reward recipient and transfers the creator rights.
• Posts announcements in the Announcement Registry.

​

Hook

​

No administrative permissions

• v5 tokens
• FeeEscrow
• Dividend Claim Helper
• Announcement Registry
• Dividend Deployer (only the factory can use it)