Custom Fees

The V4 SDK includes support for creating Doppler V4 pools that can migrate their liquidity to other Uniswap V4 pools with customizable fee streaming. This allows protocols to distribute trading fees to multiple beneficiaries over time, and importantly, customize the post-graduation fee amounts.

Overview

The StreamableFeesLocker is a contract that:

• Locks Uniswap V4 positions for a specified duration

• Streams trading fees to multiple beneficiaries

• Supports perpetual fee collection for no-op governance

• Compatible with both Doppler V3 and V4 pools when migrating to Uniswap V4

Basic Usage

1. Setting Up Beneficiaries

import { BeneficiaryData, WAD, DEAD_ADDRESS } from 'doppler-v4-sdk';

// Define beneficiaries with their share percentages
// WAD is a constant equal to 1e18, representing 100% in fixed-point arithmetic
const beneficiaries: BeneficiaryData[] = [
  {
    beneficiary: '0x...protocol', // Protocol treasury
    shares: BigInt(0.05e18), // 5% in WAD (1e18 = 100%)
  },
  {
    beneficiary: '0x...integrator', // Integrator
    shares: BigInt(0.05e18), // 5% in WAD (1e18 = 100%)
  },
  {
    beneficiary: '0x...team', // Team/DAO
    shares: BigInt(0.9e18), // 90% in WAD
  },
];

// Sort beneficiaries (required for contract validation)
const sortedBeneficiaries = factory.sortBeneficiaries(beneficiaries);

2. Creating V4 Migrator Data

import { V4MigratorData } from 'doppler-v4-sdk';

const v4MigratorConfig: V4MigratorData = {
  fee: 3000, // 0.3% in bips
  tickSpacing: 60,
  lockDuration: 30 * 24 * 60 * 60, // 30 days in seconds
  beneficiaries: sortedBeneficiaries,
};

// Encode the migrator data
const liquidityMigratorData = factory.encodeV4MigratorData(v4MigratorConfig);

Post-Migration Operations

1. Distributing Fees

Anyone can call distributeFees to collect and distribute trading fees:

import { streamableFeesLockerAbi } from 'doppler-v4-sdk';
import { createPublicClient, createWalletClient } from 'viem';

const client = createWalletClient({
  // ... client config
});

// Distribute fees for a position
const hash = await client.writeContract({
  address: addresses.streamableFeesLocker,
  abi: streamableFeesLockerAbi,
  functionName: 'distributeFees',
  args: [tokenId],
});

2. Claiming Fees (Beneficiaries)

Beneficiaries can claim their accumulated fees:

const hash = await client.writeContract({
  address: addresses.streamableFeesLocker,
  abi: streamableFeesLockerAbi,
  functionName: 'releaseFees',
  args: [tokenId],
});

3. Updating Beneficiary Address

Beneficiaries can update their address:

const hash = await client.writeContract({
  address: addresses.streamableFeesLocker,
  abi: streamableFeesLockerAbi,
  functionName: 'updateBeneficiary',
  args: [tokenId, newBeneficiaryAddress],
});

Complete Examples

For detailed, production-ready examples of launching tokens with StreamableFeesLocker:

• Token Launch Examples - Complete guide with:

  • Standard governance launch (90/10 split)

  • No-op governance launch (100% locked)

  • Custom quote token launch

  • Post-launch fee operations

Quick Example

import { 
  ReadWriteFactory, 
  BeneficiaryData, 
  V4MigratorData,
  DEAD_ADDRESS
} from 'doppler-v4-sdk';

// 1. Set up beneficiaries
const beneficiaries: BeneficiaryData[] = [
  { beneficiary: protocolAddress, shares: BigInt(0.1e18) }, // 10%
  { beneficiary: teamAddress, shares: BigInt(0.9e18) }, // 90%
];

// 2. Create V4 migrator config
const v4Config: V4MigratorData = {
  fee: 3000,
  tickSpacing: 60,
  lockDuration: 180 * 24 * 60 * 60, // 180 days
  beneficiaries: factory.sortBeneficiaries(beneficiaries),
};

// 3. Build and launch
const config = await factory.buildConfig({
  // ... token parameters
  liquidityMigratorData: factory.encodeV4MigratorData(v4Config),
}, addresses, {
  useGovernance: false // For no-op governance
});

const tx = await factory.create(config.createParams);

Key Points

1. Beneficiary Validation:

   • Beneficiaries must be sorted by address (ascending)

   • Total shares must equal exactly 1e18 (WAD)

   • All shares must be positive

2. Lock Duration:

   • Standard governance: Position unlocks after duration

   • No-op governance: Position locked forever (recipient = DEAD_ADDRESS). The lockDuration value is ignored since the position is permanently locked

3. Fee Distribution:

   • Standard governance: 90% of liquidity goes to timelock, 10% to StreamableFeesLocker (automatic split by V4Migrator contract)

   • No-op governance: 100% goes to StreamableFeesLocker permanently

4. Migration Types:

   • Standard: Creates 2 NFTs, locks 10% in StreamableFeesLocker

   • No-op: Creates 1 NFT, locks 100% in StreamableFeesLocker permanently

5. Pool Compatibility:

   • Doppler V3 Pools: Use UniswapV3Initializer + UniswapV4Migrator to get fee streaming

   • Doppler V4 Pools: Use UniswapV4Initializer + UniswapV4Migrator to get fee streaming

   • Both pool types can leverage the StreamableFeesLocker when migrating to Uniswap V4