Revenue Tokenization Documentation

# npm
npm install @poolfans/sdk viem

# yarn
yarn add @poolfans/sdk viem

# pnpm
pnpm add @poolfans/sdk viem

# bun
bun add @poolfans/sdk viem

// Deploy new token with tokenized fee rewards
const result = await tokenizer.deployWithTokenizedFees({
  // Token Configuration
  name: "My Token",
  symbol: "MTK",
  image: "ipfs://your-image-hash",
  tokenAdmin: account.address,

  // Metadata (optional)
  metadata: {
    description: "A token with tokenized rewards",
    socialMediaUrls: ["https://twitter.com/mytoken"],
  },

  // Rewards Configuration - tokenized into ERC20 shares
  rewards: {
    recipients: [
      {
        recipient: account.address,  // Revenue share holder
        admin: account.address,      // Can manage this position
        bps: 6000,                   // 60% of fees
        token: "Both",               // Receive both tokens
      },
      {
        recipient: "0x...",          // Community treasury
        admin: "0x...",
        bps: 4000,                   // 40% of fees
        token: "Both",
      },
    ],
  },

  // Fee Configuration
  fees: {
    type: "dynamic",  // or "static"
    // Dynamic fees start high (MEV protection) and decay
  },

  // Optional: Vesting Vault
  vault: {
    percentage: 20,           // 20% of supply locked
    lockupDuration: 604800,   // 7 days in seconds
    vestingDuration: 2592000, // 30 days vesting
    recipient: account.address,
  },

  // Optional: Dev Buy at launch
  devBuy: {
    ethAmount: 0.1,  // Buy 0.1 ETH worth at launch
  },
});

// Wait for deployment
const { tokenAddress, vaultAddress, txHash } = await result.waitForTransaction();

console.log("Token deployed:", tokenAddress);
console.log("Revenue vault:", vaultAddress);

// Step 1: Initialize tokenization (deploys vault)
const initResult = await tokenizer.initTokenization({
  clankerToken: "0x...",  // Your existing Clanker token
  version: "v4",          // or "v3.1.0"
  rewards: {
    recipients: [
      {
        recipient: account.address,
        admin: account.address,
        bps: 10000,  // 100% to you initially
        token: "Both",
      },
    ],
  },
});

const { vaultAddress, pendingId } = await initResult.waitForTransaction();
console.log("Vault deployed at:", vaultAddress);

// Step 2: Transfer admin to vault in Fee Locker (off-chain)
// Go to clanker.world and update your fee recipient to the vault address

// Step 3: Finalize tokenization
const finalizeResult = await tokenizer.finalizeTokenization({
  pendingId,
  clankerToken: "0x...",
});

const { sharesToken } = await finalizeResult.waitForTransaction();
console.log("Revenue shares minted:", sharesToken);

import { PoolFansTokenizer } from '@poolfans/sdk';
import type { PoolPosition } from '@poolfans/sdk';

// Custom positions for 20 ETH market cap
// The starting tick (-223400) must be <= lowest tickLower
const positions: PoolPosition[] = [
  { tickLower: -223400, tickUpper: -207000, positionBps: 1000 },  // 10%
  { tickLower: -207000, tickUpper: -148000, positionBps: 5000 },  // 50%
  { tickLower: -195000, tickUpper: -148000, positionBps: 1500 },  // 15%
  { tickLower: -148000, tickUpper: -113000, positionBps: 2000 },  // 20%
  { tickLower: -134000, tickUpper: -113000, positionBps: 500 },   // 5%
];

const result = await tokenizer.deployWithTokenizedFees({
  name: "My Token",
  symbol: "MTK",
  image: "",
  tokenAdmin: account.address,
  rewards: {
    recipients: [{
      recipient: account.address,
      admin: account.address,
      bps: 10000,
      token: "Both",
    }],
  },
  pool: {
    positions,
    tickIfToken0IsClanker: -223400,  // ~20 ETH market cap
  },
});