Clanker (Direct Contract Deployments)

​

Deploying a Token

/**
 * Configuration settings for token creation
 */

struct RewardsConfig {
    uint256 creatorReward;
    address creatorAdmin;
    address creatorRewardRecipient;
    address interfaceAdmin;
    address interfaceRewardRecipient;
}

struct TokenConfig {
    string name;
    string symbol;
    bytes32 salt;
    string image;
    string metadata;
    string context;
    uint256 originatingChainId;
}

struct VaultConfig {
    uint8 vaultPercentage;
    uint256 vaultDuration;
}

struct PoolConfig {
    address pairedToken;
    int24 tickIfToken0IsNewToken;
}

struct InitialBuyConfig {
    uint24 pairedTokenPoolFee;
    uint256 pairedTokenSwapAmountOutMinimum;
}

struct DeploymentConfig {
    TokenConfig tokenConfig;
    VaultConfig vaultConfig;
    PoolConfig poolConfig;
    InitialBuyConfig initialBuyConfig;
    RewardsConfig rewardsConfig;
}

function deployToken(DeploymentConfig tokenConfig) external payable {...}
function deployTokenWithCustomTeamRewardRecipient(DeploymentConfig tokenConfig, address teamRewardRecipient) external payable {...}

​

Rewards Configuration

• 20% to Clanker
• Up to 80% to the Creator (set with the creatorReward parameter)
• Remaining to the Interface (can be 0%)

• creatorAdmin: The address that will manage the creator’s locked token supply, creator’s portion of the trading fee rewards, the token’s metadata, and the receiver of the initial supply purchase (the “creator buy”)
• creatorRewardRecipient: The address that will initially receive the creator’s portion of the trading fee rewards
• interfaceAdmin: The address that will manage the interface’s trading fee rewards
• interfaceRewardRecipient: The address that will initially receive the interface’s portion of the trading fee rewards

​

Token Configuration

• name: Token name
• symbol: Token symbol
• image: Token image
• metadata: Token metadata (creatorAdmin can update this)
• context: Additional token context containing information about who deployed the token (immutable)
• salt: Address salt value to allow for token address customization
• originatingChainId: Chain ID where the token’s supply is deployed

​

Vault Configuration (Optional)

• vaultDuration: Lock duration (minimum 30 days)
• vaultPercentage: Percentage of supply to lock (maximum 30%)

​

Pool Configuration

• tickIfToken0IsNewToken: Initial token price in the pool
• pairedToken: Token to pair with the new token

​

Initial Swap Configuration (Optional)

• msg.value: ETH amount for the swap
• pairedTokenSwapAmountOutMinimum: Minimum amount of paired tokens to receive if ETH is not the paired token
• pairedTokenPoolFee: Pool fee for the ETH -> pairedToken swap