Changelog
Last updated
Last updated
Deployments are now more flexible with configurable starting market caps for WETH-paired tokens.
API users using the Standard Deployment endpoint may optionally pass in the initialMarketCap parameter when creating WETH-paired tokens. This defaults to 10, which creates a ~10 ETH starting market cap token. The minimum value accepted is 1, which creates a ~1 ETH starting market cap token. There is no maximum value / limit on this parameter.
Users deploying tokens via can now choose between 1, 5, and 10 ETH for their the starting market cap of their token.
Today, clanker.world and the Clanker API will surface and return info for almost all tokens deployed through the Clanker contracts (Deployed Contracts). This means that tokens deployed directly to the Clanker contracts with a variety of starting market caps and quote tokens will be included.
To help users interpret this data, we're surfacing additional info on clanker.world and adding net new response fields to the API endpoints.
Currently, clanker.world and API endpoints will return all tokens deployed on Clanker contracts EXCEPT those with warnings flags (see Frontend updates (clanker.world) for more info). Tokens with warnings flags are rare at the moment, but developers using the API should implement their own filtering logic depending on what they would like to surface to their users.
These guardrails on clanker.world and API are set to be removed on Friday, April 25, at which point all tokens deployed on Clanker contracts will be available through clanker.world and the API - regardless of the launch setup of the token. Tokens pages on clanker.world will display a banner with the relevant warnings flag, while the API will return the flag in the response.
Token pages will now show the starting market cap, referenced in the quote token that new token was deployed against. For now, all WETH-paired tokens with a starting mcap of at least 1 ETH will be shown, in addition to tokens paired against the Supported Quote Tokens at the ticks specified in the table.
Soon, (once the aforementioned guardrails are removed), clanker.world will show all tokens, irrespective of the quote token or starting market cap. Token pages will then surface warning tags for tokens deployed with atypical pool configurations. See below for a list of the current tags:
Unusual Tick
WETH-denominated tokens with a starting market cap of < 1 ETH (WETH)
Non-WETH tokens listed in Supported Quote Tokens with pools that do not match the initial tick listed in that table
Unusual Pair Address
Tokens paired with a quote token not listed in Supported Quote Tokens
Missing Pool Config
Tokens with incomplete or missing pool configuration info. These are primary legacy tokens that were deployed with a standard configuration
API endpoints will return all tokens deployed on Clanker contracts EXCEPT those with warnings flags. The exception is to provide API users with a period of time to implement their own filtering logic based on the warnings and pool_config data. These guardrails are set to be removed on Friday, April 25, at which point all tokens deployed on Clanker contracts will be available through the API - regardless of the launch setup of the token.
Please thoroughly review the new response fields below (most importantly the warnings, pool_config, and starting_market_cap fields)
New response fields will be added for the following endpoints: /tokens, /tokens/search, /tokens/fetch-deployed-by-address, and /get-clanker-by-address
New response fields:
warnings: Any warning flags associated with the token
UNUSUAL_TICK
WETH-denominated tokens with a starting market cap of < 1 ETH (WETH)
Non-WETH tokens listed in Supported Quote Tokens with pools that do not match the initial tick listed in that table
UNUSUAL_PAIR_ADDRESS
Tokens paired with a quote token not listed in Supported Quote Tokens
MISSING_POOL_CONFIG
Tokens with incomplete or missing pool configuration info. These are primary legacy tokens that were deployed with a standard configuration
pool_config: Configuration for the token's liquidity pool
starting_market_cap: Initial market capitalization, denominated in the quote token
The quote token is returned as pairedToken within pool_config
chain_id: Parsed as integer from database value
metadata: Token metadata from database
deploy_config: JSON stringified deployment configuration
social_context: JSON stringified social context (when creator info is available)
deployed_at: Deployment timestamp
msg_sender: Address that sent the transaction to deploy the token
factory_address: Address of the factory contract
locker_address: Address of the locker contract
Anyone can interact with the v0.3.1 Clanker factory contract to create clankers. Creators may deploy directly from the contract, while new interfaces can be built on top of the contracts permissionlessly.
Creators and interfaces may pass in social context (e.g. references to Farcaster casts or X posts) during their deployments, which is immutable and can serve as a link to the origin of the deployment.
Metadata such as references to the websites or social media profiles for tokens may be added as well. The metadata for tokens is mutable and can be updated by the token's admin (typically the creator).
Creators may optionally allocate up to 30% of the token supply to the creator vault at time of deployment. Creators can set the unlock time on the vault, but there is a hard minimum of 30 days. After such time has passed, creators can claim the vaulted tokens from the vault.
Deployments with creator vaults are supported through the Clanker API.
Creators may optionally send ETH during the token deployment transaction to purchase the token they are creating. This occurs after the the optional creator vault allocation is sent to the vault.
Deployments with creator buys are not yet supported through the Clanker API.
This upgrade marks the change from v0.3.0 to v0.3.1 contracts. Please refer to Deployed Contracts for the list of contracts. At this transition period, deployments through the v0.3.0 token factory will be deprecated. Presales will be deprecated and are not supported in v0.3.1.
The following endpoints will be deprecated:
Standard Deployment w/Custom Reward Splits
If you are currently using this endpoint, please contact our team for alternative deployment solutions using the Standard Deployment endpoint.