clanker

Clanker SDK

Plan and review ERC20 token deployments with built-in liquidity pools using the Clanker TypeScript SDK.

Safety and transaction approval

Token deployment is an irreversible financial action. Default to read-only planning and testnet simulation.

• Never ask the user to paste a private key into chat, source files, examples, or logs. Use the harness secret store or an untracked local environment file.
• Confirm the chain ID, token parameters, administrator and reward addresses, expected fees, slippage assumptions, and contract source before preparing a transaction.
• Show the final transaction payload and estimated cost. Require explicit human approval immediately before signing or broadcasting.
• Never claim profitability, liquidity, safety, or audit status. Preserve the transaction hash and verified explorer link in the receipt.

Overview

Clanker is a token deployment protocol that creates ERC20 tokens with Uniswap V4 liquidity pools in a single transaction. The SDK provides a TypeScript interface for deploying tokens with advanced features like vesting, airdrops, and customizable reward distribution.

Quick Start

Installation

npm install clanker-sdk viem
# or
yarn add clanker-sdk viem
# or
pnpm add clanker-sdk viem

Environment Setup

Configure the signing key through the harness secret store. If local environment variables are unavoidable, use an untracked .env file with restrictive permissions and never display its contents:

PRIVATE_KEY=0x...your_private_key_here

Basic Token Deployment

import { Clanker } from 'clanker-sdk';
import { createPublicClient, createWalletClient, http, type PublicClient } from 'viem';
import { privateKeyToAccount } from 'viem/accounts';
import { base } from 'viem/chains';

const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`;
const account = privateKeyToAccount(PRIVATE_KEY);

const publicClient = createPublicClient({
  chain: base,
  transport: http(),
}) as PublicClient;

const wallet = createWalletClient({
  account,
  chain: base,
  transport: http(),
});

const clanker = new Clanker({ wallet, publicClient });

const { txHash, waitForTransaction, error } = await clanker.deploy({
  name: 'My Token',
  symbol: 'TKN',
  image: 'ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi',
  tokenAdmin: account.address,
  metadata: {
    description: 'My awesome token',
  },
  context: {
    interface: 'Clanker SDK',
  },
  vanity: true,
});

if (error) throw error;

const { address: tokenAddress } = await waitForTransaction();
console.log('Token deployed at:', tokenAddress);