[NEW] Deploy Token (v4.0.0)

Deploy a new token on Clanker v4.0.0

Live: This endpoint is now available for use.

If you are currently using [PLANNED EOL] Deploy Token (v3.1.0) or [PLANNED EOL] Deploy Token w/Splits (v3.1.0), please migrate your service to this endpoint by July 31.

POST https://www.clanker.world/api/tokens/deploy/v4

Headers

Name

Value

x-api-key

your_api_key

Content-Type

application/json

Body

Parameter

Type

Required

Description

token.name

string

Required

The name of your token

token.symbol

string

Required

Token symbol (usually 3-5 characters)

token.image

string

Optional

URL to the token's image

token.tokenAdmin

0x${string}

Required

Token admin address with control over vaulted tokens and updating token metadata

token.description

string

Optional

Description of token for creators to provide

token.socialMediaUrls

array of { platform: string, url: string }

Optional

URLs for external pages related to the token

token.auditUrls

array

Optional

Links to any audits, reports, etc.

token.requestKey

string

Required

Unique 32 character unique request identifier

rewards

array

Required

Array of reward configuration objects (at least one required)

rewards.admin

0x${string}

Required

Address that can change the paired recipient

rewards.recipient

0x${string}

Required

Address that will receive the rewards once claimed

rewards.allocation

number

Required

Percentage of rewards (total across all recipients should sum to 100)

rewards.rewardsToken

string

Optional

Token(s) in which the recipient will accrue rewards. Either "Both", "Clanker", or "Paired"

pool.type

strings

Optional

Either "standard" or "project"

pool.pairedToken

0x${string}

Optional

Token address to pair the new token with (typically WETH). Only for standard pool.type

pool.initialMarketCap

number

Optional

Starting market cap denominated in pairedToken. Only for standard pool.type

fees.type

string

Optional

Fee type: either "static" or "dynamic"

fees.clankerFee

number

Optional

Fee percentage on Clanker token inputs, max 5 (5%). Only for static fees.type

fees.pairedFee

number

Optional

Fee percentage on pairedToken inputs, max 5 (5%). Only for static fees.type

fees.baseFee

number

Optional

Base fee charged on every swap, minimum 0.25 (0.25%). Only for dynamic fees.type

fees.maxLpFee

number

Optional

Maximum LP fee including base + variable fee, maximum 5 (5%). Only for dynamic fees.type

vault.percentage

number

Optional

Percentage of tokens to vault (max 90% total across all extensions)

vault.lockupDuration

number

Conditional

Lockup duration in days, minimum 7. Required if vault.percentage is provided

vault.vestingDuration

number

Conditional

Vesting duration in seconds, can be 0 for instant vesting. Required if vault.percentage is provided

Response

{
  "message": "Token deployment enqueued. Expected address: [contract_address]",
  "expectedAddress": "[contract_address]",
  "success": true
}

{
  "data": [
    {
      "code": "validation_error",
      "path": ["field_name"],
      "message": "Description of the validation error"
    }
  ],
  "error": "Invalid input. See data for details."
}

Example Request

curl -X POST 'https://www.clanker.world/api/tokens/deploy/v4' \
-H 'Content-Type: application/json' \
-H 'x-api-key: your_api_key_here' \
-d '{
  "token": {
    "name": "DemoToken",
    "symbol": "DEMO",
    "image": "https://example.com/demo-token-logo.png",
    "tokenAdmin": "0x742d35Cc6634C0532925a3b8D4C9db7cd4b5b31D",
    "description": "Clanker v4.0.0",
    "socialMediaUrls": [
      "https://x.com/demotoken",
      "https://t.me/demotoken"
    ],
    "auditUrls": [
      "https://example.com/audit-report-1.pdf",
      "https://example.com/security-review.pdf"
    ],
    "requestKey": "abcdef1234567890abcdef1234567890"
  },
  "rewards": [
    {
      "admin": "0x742d35Cc6634C0532925a3b8D4C9db7cd4b5b31D",
      "recipient": "0x742d35Cc6634C0532925a3b8D4C9db7cd4b5b31D",
      "allocation": 50,
      "rewardsToken": "Both"
    },
    {
      "admin": "0x8ba1f109551bD432803012645Hac136c3c89d97c",
      "recipient": "0x8ba1f109551bD432803012645Hac136c3c89d97c",
      "allocation": 30,
      "rewardsToken": "Clanker"
    },
    {
      "admin": "0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984",
      "recipient": "0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984",
      "allocation": 20,
      "rewardsToken": "Paired"
    }
  ],
  "pool": {
    "type": "standard",
    "pairedToken": "0x4200000000000000000000000000000000000006",
    "initialMarketCap": 10
  },
  "fees": {
    "type": "static",
    "clankerFee": 1,
    "pairedFee": 1
  },
  "vault": {
    "percentage": 15,
    "lockupDuration": 30,
    "vestingDuration": 0
  }
}'

const deployToken = async () => {
 try {
   const response = await fetch('https://www.clanker.world/api/tokens/deploy/v4', {
     method: 'POST',
     headers: {
       'Content-Type': 'application/json',
       'x-api-key': 'your_api_key_here'
     },
     body: JSON.stringify({
       token: {
         name: "DemoToken",
         symbol: "DEMO",
         image: "https://example.com/demo-token-logo.png",
         tokenAdmin: "0x742d35Cc6634C0532925a3b8D4C9db7cd4b5b31D",
         description: "Clanker v4.0.0",
         socialMediaUrls: [
           "https://x.com/demotoken",
           "https://t.me/demotoken"
         ],
         auditUrls: [
           "https://example.com/audit-report-1.pdf",
           "https://example.com/security-review.pdf"
         ],
         requestKey: "abcdef1234567890abcdef1234567890"
       },
       rewards: [
         {
           admin: "0x742d35Cc6634C0532925a3b8D4C9db7cd4b5b31D",
           recipient: "0x742d35Cc6634C0532925a3b8D4C9db7cd4b5b31D",
           allocation: 50,
           rewardsToken: "Both"
         },
         {
           admin: "0x8ba1f109551bD432803012645Hac136c3c89d97c",
           recipient: "0x8ba1f109551bD432803012645Hac136c3c89d97c",
           allocation: 30,
           rewardsToken: "Clanker"
         },
         {
           admin: "0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984",
           recipient: "0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984",
           allocation: 20,
           rewardsToken: "Paired"
         }
       ],
       pool: {
         type: "standard",
         pairedToken: "0x4200000000000000000000000000000000000006",
         initialMarketCap: 10
       },
       fees: {
         type: "static",
         clankerFee: 1,
         pairedFee: 1
       },
       vault: {
         percentage: 15,
         lockupDuration: 30,
         vestingDuration: 0
       }
     })
   });

   if (!response.ok) {
     const errorData = await response.json();
     throw new Error(errorData.error || `HTTP error! status: ${response.status}`);
   }

   const data = await response.json();
   console.log('Token deployment successful:', data);
   return data;
   
 } catch (error) {
   console.error('Token deployment failed:', error);
   throw error;
 }
};

deployToken()
 .then(result => {
   console.log('Expected address:', result.expectedAddress);
 })
 .catch(error => {
   console.error('Error:', error);
 });

Notes

Rewards Configuration

At least one reward configuration is required.
Up to 7 total reward recipients are allowed.
Total allocation across all recipients must sum to 100 (100%).
Admin addresses can change the recipient address but allocation percentages are immutable.

With the v4.0.0 deployment endpoint, token creation interfaces must include their own reward configuration if they wish to receive any rewards for v4.0.0 tokens.

Each reward recipient may have a designated rewardsToken set. This specifies the token in which the recipient will accrue rewards in, irrespective of how the fees are set to be collected via the Fee Configuration.
Defaults
- rewardsToken defaults to Paired , so rewards recipients will accrue rewards in only the paired token (typically WETH)

Pool Configuration (optional)

Choose a paired token from the list of Supported Quote Tokens along with the starting market cap of the token, denominated in the paired token.
Defaults
- "Standard" pool configuration with single LP position.
- Quote token is set to WETH (0x4200000000000000000000000000000000000006) if no pairedToken is provided.
- Starting market cap is set to the Approximate Starting Market Cap column in the Supported Quote Tokens table if no initialMarketCap is provided.

Fee Configuration (optional)

Choose either static or dynamic fee type, not both.
- Static fees apply fixed percentages to specific token inputs (no min, 5% max).
- Dynamic fees include a base fee plus variable fees based on volatility and are applied to equally to both token inputs (0.25% min, 5% max).
Defaults
- Fee configuration defaults to a 1% static fee on both token inputs if not provided.
- If static is selected, the static fee configuration defaults to a 1% static fee on both token inputs if not specified.
- If dynamic is selected, the dynamic fee configuration defaults to a 0.5% base fee and 5% max LP fee if not specified.

Vault Extension (optional)

Optional feature for locking tokens with configurable lockup and vesting periods.
Maximum 90% of total supply can be allocated across all extensions.
Minimum lockupDuration is 7 days, no minimum vesting duration.
- There is no minimum vestingDuration, as setting vestingDuration to 0 allows all vaulted tokens to be claimed once lockupDuration ends.

PreviousAuthenticated NextGet Token by Address

Last updated 3 hours ago