@whetstone-research/doppler-sdk 0.0.24 → 1.0.0

package/dist/types.d.mts

@@ -1,662 +0,0 @@
-import { mainnet, sepolia, base, baseSepolia, ink, unichain } from 'viem/chains';
-import { SupportedChainId } from './addresses.mjs';
-import { WalletClient, Address } from 'viem';
-
-type SupportedChain = typeof mainnet | typeof sepolia | typeof base | typeof baseSepolia | typeof ink | typeof unichain;
-type SupportedPublicClient = unknown;
-interface StandardTokenConfig {
-    type?: 'standard';
-    name: string;
-    symbol: string;
-    tokenURI: string;
-    yearlyMintRate?: bigint;
-}
-interface Doppler404TokenConfig {
-    type: 'doppler404';
-    name: string;
-    symbol: string;
-    baseURI: string;
-    unit?: bigint;
-}
-type TokenConfig = StandardTokenConfig | Doppler404TokenConfig;
-interface SaleConfig {
-    initialSupply: bigint;
-    numTokensToSell: bigint;
-    numeraire: Address;
-}
-interface StaticPoolConfig {
-    startTick: number;
-    endTick: number;
-    fee: number;
-    numPositions?: number;
-    maxShareToBeSold?: bigint;
-    beneficiaries?: BeneficiaryData[];
-}
-interface DynamicAuctionConfig {
-    duration: number;
-    epochLength: number;
-    startTick: number;
-    endTick: number;
-    gamma?: number;
-    minProceeds: bigint;
-    maxProceeds: bigint;
-    numPdSlugs?: number;
-}
-interface VestingConfig {
-    duration: number;
-    cliffDuration: number;
-    recipients?: Address[];
-    amounts?: bigint[];
-}
-declare const NO_OP_ENABLED_CHAIN_IDS: readonly [1, 11155111, 8453, 84532, 130, 1301, 10143, 143];
-type NoOpEnabledChainId = (typeof NO_OP_ENABLED_CHAIN_IDS)[number];
-/**
- * Check if a chain supports no-op governance
- */
-declare function isNoOpEnabledChain(chainId: number): chainId is NoOpEnabledChainId;
-declare const LAUNCHPAD_ENABLED_CHAIN_IDS: readonly [8453, 143];
-type LaunchpadEnabledChainId = (typeof LAUNCHPAD_ENABLED_CHAIN_IDS)[number];
-/**
- * Check if a chain supports launchpad governance
- */
-declare function isLaunchpadEnabledChain(chainId: number): chainId is LaunchpadEnabledChainId;
-type GovernanceDefault = {
-    type: 'default';
-};
-interface GovernanceCustom {
-    type: 'custom';
-    initialVotingDelay: number;
-    initialVotingPeriod: number;
-    initialProposalThreshold: bigint;
-}
-type GovernanceNoOp = {
-    type: 'noOp';
-};
-interface GovernanceLaunchpad {
-    type: 'launchpad';
-    multisig: Address;
-}
-type GovernanceOption<C extends SupportedChainId> = GovernanceDefault | GovernanceCustom | (C extends NoOpEnabledChainId ? GovernanceNoOp : never) | (C extends LaunchpadEnabledChainId ? GovernanceLaunchpad : never);
-interface BeneficiaryData {
-    beneficiary: Address;
-    shares: bigint;
-}
-declare enum LockablePoolStatus {
-    Uninitialized = 0,
-    Initialized = 1,
-    Locked = 2,
-    Exited = 3
-}
-interface LockablePoolState {
-    asset: Address;
-    numeraire: Address;
-    tickLower: number;
-    tickUpper: number;
-    maxShareToBeSold: bigint;
-    totalTokensOnBondingCurve: bigint;
-    status: LockablePoolStatus;
-}
-interface MulticurvePoolState {
-    asset: Address;
-    numeraire: Address;
-    fee: number;
-    tickSpacing: number;
-    status: LockablePoolStatus;
-    poolKey: V4PoolKey;
-    farTick: number;
-}
-interface RehypeDopplerHookMigratorConfig {
-    hookAddress?: Address;
-    buybackDestination: Address;
-    customFee: number;
-    feeRoutingMode?: RehypeFeeRoutingMode | 'directBuyback' | 'routeToBeneficiaryFees';
-    feeDistributionInfo?: RehypeFeeDistributionInfo;
-    /**
-     * @deprecated Use feeDistributionInfo.* fields instead.
-     * If feeDistributionInfo is omitted, legacy percentages are mirrored to both rows.
-     */
-    assetBuybackPercentWad?: bigint;
-    /**
-     * @deprecated Use feeDistributionInfo.* fields instead.
-     */
-    numeraireBuybackPercentWad?: bigint;
-    /**
-     * @deprecated Use feeDistributionInfo.* fields instead.
-     */
-    beneficiaryPercentWad?: bigint;
-    /**
-     * @deprecated Use feeDistributionInfo.* fields instead.
-     */
-    lpPercentWad?: bigint;
-}
-interface DopplerHookMigrationConfig {
-    type: 'dopplerHook';
-    fee: number;
-    useDynamicFee?: boolean;
-    tickSpacing: number;
-    lockDuration: number;
-    beneficiaries: BeneficiaryData[];
-    hook?: {
-        hookAddress: Address;
-        onInitializationCalldata?: `0x${string}`;
-    };
-    rehype?: RehypeDopplerHookMigratorConfig;
-    proceedsSplit?: {
-        recipient: Address;
-        share: bigint;
-    };
-}
-type MigrationConfig = {
-    type: 'uniswapV2';
-} | {
-    type: 'uniswapV4';
-    fee: number;
-    tickSpacing: number;
-    streamableFees?: {
-        lockDuration: number;
-        beneficiaries: BeneficiaryData[];
-    };
-} | DopplerHookMigrationConfig | {
-    type: 'noOp';
-};
-interface CreateStaticAuctionParams<C extends SupportedChainId = SupportedChainId> {
-    token: TokenConfig;
-    sale: SaleConfig;
-    pool: StaticPoolConfig;
-    vesting?: VestingConfig;
-    governance: GovernanceOption<C>;
-    migration: MigrationConfig;
-    integrator?: Address;
-    userAddress: Address;
-    modules?: ModuleAddressOverrides;
-    gas?: bigint;
-}
-interface CreateDynamicAuctionParams<C extends SupportedChainId = SupportedChainId> {
-    token: TokenConfig;
-    sale: SaleConfig;
-    auction: DynamicAuctionConfig;
-    pool: {
-        fee: number;
-        tickSpacing: number;
-    };
-    vesting?: VestingConfig;
-    governance: GovernanceOption<C>;
-    migration: MigrationConfig;
-    integrator?: Address;
-    userAddress: Address;
-    startTimeOffset?: number;
-    blockTimestamp?: number;
-    gas?: bigint;
-    modules?: ModuleAddressOverrides;
-}
-interface PriceRange {
-    startPrice: number;
-    endPrice: number;
-}
-interface TickRange {
-    startTick: number;
-    endTick: number;
-}
-/**
- * Market cap range in USD for price configurations.
- * Used to define start and end market caps for bonding curves.
- */
-interface MarketCapRange {
-    /** Starting market cap in USD (e.g., 100_000 for $100k) */
-    start: number;
-    /** Ending market cap in USD (e.g., 10_000_000 for $10M) */
-    end: number;
-}
-/**
- * Base configuration for market cap-based tick calculations.
- * Used by builder methods to convert market caps to ticks.
- */
-interface MarketCapConfig {
-    /** Target market cap range in USD */
-    marketCap: MarketCapRange;
-    /** Price of numeraire in USD (e.g., 3000 for ETH at $3000) */
-    numerairePrice: number;
-    /**
-     * Token supply override. If not provided, inferred from saleConfig.initialSupply.
-     * Must include decimals (e.g., parseEther('1000000000') for 1B tokens).
-     */
-    tokenSupply?: bigint;
-    /** Token decimals (default: 18) */
-    tokenDecimals?: number;
-    /** Numeraire decimals (default: 18) */
-    numeraireDecimals?: number;
-}
-/**
- * Market cap configuration for V3 Static Auctions.
- * Extends base config with V3-specific parameters.
- */
-interface StaticAuctionMarketCapConfig extends MarketCapConfig {
-    /** Fee tier in basis points (e.g., 10000 for 1%). Default: 10000 */
-    fee?: number;
-    /** Number of liquidity positions. Default: 15 */
-    numPositions?: number;
-    /** Maximum share of tokens to sell per position (WAD). Default: 35% */
-    maxShareToBeSold?: bigint;
-}
-/**
- * Market cap range for V4 Dynamic Auctions (Dutch auctions).
- * Uses start/min because price descends from start to minimum.
- */
-interface DynamicMarketCapRange {
-    /** Starting market cap in USD - auction begins here (e.g., 500_000 for $500k) */
-    start: number;
-    /** Minimum market cap in USD - floor price the auction descends to (e.g., 50_000 for $50k) */
-    min: number;
-}
-/**
- * Market cap configuration for V4 Dynamic Auctions.
- * Uses start/min (not start/end) because Dutch auctions descend from start to minimum.
- */
-interface DynamicAuctionMarketCapConfig {
-    /** Target market cap range (start = launch price, min = floor price) */
-    marketCap: DynamicMarketCapRange;
-    /** Price of numeraire in USD (e.g., 3000 for ETH at $3000) */
-    numerairePrice: number;
-    /**
-     * Token supply override. If not provided, inferred from saleConfig.initialSupply.
-     * Must include decimals (e.g., parseEther('1000000000') for 1B tokens).
-     */
-    tokenSupply?: bigint;
-    /** Token decimals (default: 18) */
-    tokenDecimals?: number;
-    /** Numeraire decimals (default: 18) */
-    numeraireDecimals?: number;
-    /**
-     * Pool fee in basis points. Default: 10000 (1%)
-     *
-     * V4 pools support any fee from 0 to 100,000 (10%).
-     * Standard tiers (100, 500, 3000, 10000) auto-derive tickSpacing.
-     * Custom fees require explicit tickSpacing parameter.
-     */
-    fee?: number;
-    /**
-     * Tick spacing for the pool. Required for custom fees.
-     *
-     * Must be <= 30 for Doppler pools (MAX_TICK_SPACING constraint).
-     * If not provided with a standard fee tier, defaults to 30.
-     */
-    tickSpacing?: number;
-    /** Minimum proceeds required for successful auction */
-    minProceeds: bigint;
-    /** Maximum proceeds cap for the auction */
-    maxProceeds: bigint;
-    /** Auction duration in seconds. Default: 7 days */
-    duration?: number;
-    /** Epoch length in seconds. Default: 3600 (1 hour) */
-    epochLength?: number;
-    /** Gamma (tick decay per epoch). Auto-calculated if not provided */
-    gamma?: number;
-    /** Number of price discovery slugs. Default: 5 */
-    numPdSlugs?: number;
-}
-/**
- * Result of market cap parameter validation.
- */
-interface MarketCapValidationResult {
-    /** Whether all parameters are within normal bounds */
-    valid: boolean;
-    /** Warning messages for unusual but technically valid values */
-    warnings: string[];
-}
-/**
- * Parameters for converting market cap range to ticks for V3 Static Auctions.
- */
-interface StaticAuctionTickParams {
-    marketCapRange: MarketCapRange;
-    tokenSupply: bigint;
-    numerairePriceUSD: number;
-    tickSpacing: number;
-    tokenDecimals?: number;
-    numeraireDecimals?: number;
-}
-/**
- * Parameters for converting market cap range to ticks for V4 Dynamic Auctions.
- */
-interface DynamicAuctionTickParams {
-    marketCapRange: MarketCapRange;
-    tokenSupply: bigint;
-    numerairePriceUSD: number;
-    numeraire: Address;
-    tickSpacing: number;
-    tokenDecimals?: number;
-    numeraireDecimals?: number;
-}
-/**
- * Parameters for converting market cap range to ticks for V4 Multicurve pools.
- */
-interface MulticurveTickRangeParams {
-    marketCapLower: number;
-    marketCapUpper: number | 'max';
-    tokenSupply: bigint;
-    numerairePriceUSD: number;
-    tickSpacing: number;
-    tokenDecimals?: number;
-    numeraireDecimals?: number;
-}
-/**
- * Parameters for converting a single market cap to a tick for Multicurve.
- */
-interface MulticurveTickParams {
-    marketCapUSD: number;
-    tokenSupply: bigint;
-    numerairePriceUSD: number;
-    tickSpacing: number;
-    tokenDecimals?: number;
-    numeraireDecimals?: number;
-}
-/**
- * Parameters for converting a tick to market cap (reverse conversion).
- */
-interface TickToMarketCapParams {
-    tick: number;
-    tokenSupply: bigint;
-    numerairePriceUSD: number;
-    tokenDecimals?: number;
-    numeraireDecimals?: number;
-}
-/**
- * Curve configuration for Multicurve pools using market cap ranges.
- * Each curve defines a market cap range and liquidity distribution.
- */
-interface MulticurveMarketCapRangeCurve {
-    /** Market cap range for this curve */
-    marketCap: {
-        /** Start market cap in USD (for the first curve, this is the launch price) */
-        start: number;
-        /** End market cap in USD, or 'max' for MAX_TICK rounded to tick spacing */
-        end: number | 'max';
-    };
-    /** Number of liquidity positions in this curve */
-    numPositions: number;
-    /** Share of total supply allocated to this curve (WAD, e.g., parseEther('0.3') = 30%) */
-    shares: bigint;
-}
-/**
- * Market cap-based configuration for Multicurve pools.
- * No tick math required - just specify market caps in USD.
- */
-interface MulticurveMarketCapCurvesConfig {
-    /** Price of numeraire in USD (e.g., 3000 for ETH at $3000) */
-    numerairePrice: number;
-    /**
-     * Array of curves defining market cap ranges and liquidity distribution.
-     * The first curve's marketCap.start is the launch price.
-     * Curves must be contiguous (no gaps allowed).
-     */
-    curves: MulticurveMarketCapRangeCurve[];
-    /** Token supply override */
-    tokenSupply?: bigint;
-    /** Token decimals (default: 18) */
-    tokenDecimals?: number;
-    /** Numeraire decimals (default: 18) */
-    numeraireDecimals?: number;
-    /** Fee tier (default: FEE_TIERS.LOW) */
-    fee?: number;
-    /** Tick spacing (derived from fee if not provided) */
-    tickSpacing?: number;
-    /** Optional beneficiaries for fee streaming */
-    beneficiaries?: BeneficiaryData[];
-}
-interface StaticAuctionBuildConfig {
-    name: string;
-    symbol: string;
-    totalSupply?: bigint;
-    numTokensToSell?: bigint;
-    tokenURI: string;
-    startTimeOffset?: number;
-    numeraire: Address;
-    tickRange?: TickRange;
-    priceRange?: PriceRange;
-    fee?: number;
-    numPositions?: number;
-    maxShareToBeSold?: bigint;
-    yearlyMintRate?: bigint;
-    vestingDuration?: bigint;
-    recipients?: Address[];
-    amounts?: bigint[];
-    migration: MigrationConfig;
-    integrator?: Address;
-    useGovernance?: boolean;
-}
-interface DynamicAuctionBuildConfig {
-    name: string;
-    symbol: string;
-    totalSupply: bigint;
-    numTokensToSell: bigint;
-    tokenURI: string;
-    startTimeOffset?: number;
-    blockTimestamp?: number;
-    duration?: number;
-    epochLength?: number;
-    numeraire?: Address;
-    tickRange?: TickRange;
-    priceRange?: PriceRange;
-    tickSpacing: number;
-    gamma?: number;
-    fee: number;
-    minProceeds: bigint;
-    maxProceeds: bigint;
-    numPdSlugs?: number;
-    yearlyMintRate?: bigint;
-    vestingDuration: bigint;
-    recipients: Address[];
-    amounts: bigint[];
-    migration: MigrationConfig;
-    integrator?: Address;
-    useGovernance?: boolean;
-}
-interface DopplerSDKConfig {
-    publicClient: SupportedPublicClient;
-    walletClient?: WalletClient;
-    chainId: number;
-}
-interface PoolInfo {
-    address: Address;
-    tokenAddress: Address;
-    numeraireAddress: Address;
-    fee: number;
-    liquidity: bigint;
-    sqrtPriceX96: bigint;
-}
-interface HookInfo {
-    hookAddress: Address;
-    tokenAddress: Address;
-    numeraireAddress: Address;
-    poolId: string;
-    currentEpoch: number;
-    totalProceeds: bigint;
-    totalTokensSold: bigint;
-    earlyExit: boolean;
-    insufficientProceeds: boolean;
-    startingTime: bigint;
-    endingTime: bigint;
-    epochLength: bigint;
-    minimumProceeds: bigint;
-    maximumProceeds: bigint;
-}
-interface QuoteResult {
-    amountOut: bigint;
-    priceImpact: number;
-    fee: bigint;
-    route: string[];
-}
-interface LockableV3InitializerParams {
-    fee: number;
-    tickLower: number;
-    tickUpper: number;
-    numPositions: number;
-    maxShareToBeSold: bigint;
-    beneficiaries: BeneficiaryData[];
-}
-interface MulticurveCurve {
-    tickLower: number;
-    tickUpper: number;
-    numPositions: number;
-    shares: bigint;
-}
-type MulticurveMarketCapPreset = 'low' | 'medium' | 'high';
-interface V4PoolKey {
-    currency0: Address;
-    currency1: Address;
-    fee: number;
-    tickSpacing: number;
-    hooks: Address;
-}
-interface MulticurveBundleExactOutResult {
-    asset: Address;
-    poolKey: V4PoolKey;
-    amountIn: bigint;
-    gasEstimate: bigint;
-}
-interface MulticurveBundleExactInResult {
-    asset: Address;
-    poolKey: V4PoolKey;
-    amountOut: bigint;
-    gasEstimate: bigint;
-}
-interface RehypeFeeDistributionInfo {
-    assetFeesToAssetBuybackWad: bigint;
-    assetFeesToNumeraireBuybackWad: bigint;
-    assetFeesToBeneficiaryWad: bigint;
-    assetFeesToLpWad: bigint;
-    numeraireFeesToAssetBuybackWad: bigint;
-    numeraireFeesToNumeraireBuybackWad: bigint;
-    numeraireFeesToBeneficiaryWad: bigint;
-    numeraireFeesToLpWad: bigint;
-}
-declare enum RehypeFeeRoutingMode {
-    DirectBuyback = 0,
-    RouteToBeneficiaryFees = 1
-}
-interface RehypeDopplerHookConfig {
-    hookAddress: Address;
-    buybackDestination: Address;
-    startFee?: number;
-    endFee?: number;
-    durationSeconds?: number | bigint;
-    startingTime?: number | bigint | Date;
-    feeRoutingMode?: RehypeFeeRoutingMode | 'directBuyback' | 'routeToBeneficiaryFees';
-    feeDistributionInfo?: RehypeFeeDistributionInfo;
-    /**
-     * @deprecated Use startFee/endFee instead. When provided alone, maps to startFee=endFee=customFee.
-     */
-    customFee?: number;
-    /**
-     * @deprecated Use feeDistributionInfo.* fields instead.
-     * If feeDistributionInfo is omitted, legacy percentages are mirrored to both rows.
-     */
-    assetBuybackPercentWad?: bigint;
-    /**
-     * @deprecated Use feeDistributionInfo.* fields instead.
-     */
-    numeraireBuybackPercentWad?: bigint;
-    /**
-     * @deprecated Use feeDistributionInfo.* fields instead.
-     */
-    beneficiaryPercentWad?: bigint;
-    /**
-     * @deprecated Use feeDistributionInfo.* fields instead.
-     */
-    lpPercentWad?: bigint;
-    graduationCalldata?: `0x${string}`;
-    graduationMarketCap?: number;
-    numerairePrice?: number;
-    farTick?: number;
-}
-interface MulticurveDecayFeeSchedule {
-    startingTime: number;
-    startFee: number;
-    endFee: number;
-    lastFee: number;
-    durationSeconds: number;
-}
-type MulticurveInitializerConfig = {
-    type: 'standard';
-} | {
-    type: 'scheduled';
-    startTime: number;
-} | {
-    type: 'decay';
-    startTime: number;
-    startFee: number;
-    durationSeconds: number;
-} | {
-    type: 'rehype';
-    config: RehypeDopplerHookConfig;
-};
-interface CreateMulticurveParams<C extends SupportedChainId = SupportedChainId> {
-    token: TokenConfig;
-    sale: SaleConfig;
-    pool: {
-        fee: number;
-        tickSpacing: number;
-        curves: MulticurveCurve[];
-        beneficiaries?: BeneficiaryData[];
-    };
-    initializer?: MulticurveInitializerConfig;
-    /**
-     * @deprecated Use initializer: { type: 'scheduled', startTime } instead.
-     * Retained for backwards compatibility.
-     */
-    schedule?: {
-        startTime: number;
-    };
-    /**
-     * @deprecated Use initializer: { type: 'rehype', config } instead.
-     * Retained for backwards compatibility.
-     */
-    dopplerHook?: RehypeDopplerHookConfig;
-    vesting?: VestingConfig;
-    governance: GovernanceOption<C>;
-    migration: MigrationConfig;
-    integrator?: Address;
-    userAddress: Address;
-    modules?: ModuleAddressOverrides;
-    gas?: bigint;
-}
-interface CreateParams {
-    initialSupply: bigint;
-    numTokensToSell: bigint;
-    numeraire: Address;
-    tokenFactory: Address;
-    tokenFactoryData: `0x${string}`;
-    governanceFactory: Address;
-    governanceFactoryData: `0x${string}`;
-    poolInitializer: Address;
-    poolInitializerData: `0x${string}`;
-    liquidityMigrator: Address;
-    liquidityMigratorData: `0x${string}`;
-    integrator: Address;
-    salt: `0x${string}`;
-}
-interface ModuleAddressOverrides {
-    airlock?: Address;
-    tokenFactory?: Address;
-    v3Initializer?: Address;
-    lockableV3Initializer?: Address;
-    v4Initializer?: Address;
-    v4MulticurveInitializer?: Address;
-    v4ScheduledMulticurveInitializer?: Address;
-    v4DecayMulticurveInitializer?: Address;
-    dopplerHookInitializer?: Address;
-    rehypeDopplerHookInitializer?: Address;
-    /**
-     * @deprecated Use rehypeDopplerHookInitializer instead.
-     */
-    rehypeDopplerHook?: Address;
-    governanceFactory?: Address;
-    poolManager?: Address;
-    dopplerDeployer?: Address;
-    v2Migrator?: Address;
-    v4Migrator?: Address;
-    dopplerHookMigrator?: Address;
-    rehypeDopplerHookMigrator?: Address;
-    noOpMigrator?: Address;
-}
-
-export { type BeneficiaryData, type CreateDynamicAuctionParams, type CreateMulticurveParams, type CreateParams, type CreateStaticAuctionParams, type Doppler404TokenConfig, type DopplerHookMigrationConfig, type DopplerSDKConfig, type DynamicAuctionBuildConfig, type DynamicAuctionConfig, type DynamicAuctionMarketCapConfig, type DynamicAuctionTickParams, type DynamicMarketCapRange, type GovernanceCustom, type GovernanceDefault, type GovernanceLaunchpad, type GovernanceNoOp, type GovernanceOption, type HookInfo, LAUNCHPAD_ENABLED_CHAIN_IDS, type LaunchpadEnabledChainId, type LockablePoolState, LockablePoolStatus, type LockableV3InitializerParams, type MarketCapConfig, type MarketCapRange, type MarketCapValidationResult, type MigrationConfig, type ModuleAddressOverrides, type MulticurveBundleExactInResult, type MulticurveBundleExactOutResult, type MulticurveCurve, type MulticurveDecayFeeSchedule, type MulticurveInitializerConfig, type MulticurveMarketCapCurvesConfig, type MulticurveMarketCapPreset, type MulticurveMarketCapRangeCurve, type MulticurvePoolState, type MulticurveTickParams, type MulticurveTickRangeParams, NO_OP_ENABLED_CHAIN_IDS, type NoOpEnabledChainId, type PoolInfo, type PriceRange, type QuoteResult, type RehypeDopplerHookConfig, type RehypeDopplerHookMigratorConfig, type RehypeFeeDistributionInfo, RehypeFeeRoutingMode, type SaleConfig, type StandardTokenConfig, type StaticAuctionBuildConfig, type StaticAuctionMarketCapConfig, type StaticAuctionTickParams, type StaticPoolConfig, type SupportedChain, SupportedChainId, type SupportedPublicClient, type TickRange, type TickToMarketCapParams, type TokenConfig, type V4PoolKey, type VestingConfig, isLaunchpadEnabledChain, isNoOpEnabledChain };