@gala-chain/launchpad-sdk 5.0.4-beta.6 → 5.0.4-beta.60

package/dist/types/launchpad.dto.d.ts

@@ -0,0 +1,1264 @@
+/**
+ * Data Transfer Objects (DTOs) for Launchpad API operations
+ *
+ * These types define the interface between the SDK and the backend.
+ * They handle type adaptation between clean SDK interfaces and backend quirks.
+ */
+import type { AddressFormat, HolderTierInfo, InternalApiResponse, ListResult, SearchablePaginationOptions } from './common';
+import type { StreamStatus } from './streaming.dto';
+import type { EIP712Domain, EIP712Types } from './trade.dto';
+/**
+ * Options for uploading an image to the launchpad
+ */
+export interface ImageUploadOptions {
+    /** Image file - can be browser File object or Node.js Buffer */
+    file: File | Buffer;
+    /** Token name (lowercase, max 10 characters) */
+    tokenName: string;
+}
+/**
+ * Internal response from image upload endpoint
+ */
+export interface InternalImageUploadResponse {
+    /** Success status */
+    success: boolean;
+    /** HTTP status code */
+    status: number;
+    /** Error flag */
+    error: boolean;
+    /** Upload result data */
+    data?: {
+        /** Uploaded image URL or identifier */
+        imageUrl?: string;
+        /** Image metadata */
+        [key: string]: unknown;
+    };
+    /** Error message if upload failed */
+    message?: string;
+}
+/**
+ * Social media URLs for a token pool
+ * At least one URL is required
+ */
+export interface TokenUrls {
+    /** Website URL (optional) */
+    websiteUrl?: string;
+    /** Telegram channel URL (optional) */
+    telegramUrl?: string;
+    /** Twitter profile URL (optional) */
+    twitterUrl?: string;
+    /** Instagram profile URL (optional) */
+    instagramUrl?: string;
+    /** Facebook page URL (optional) */
+    facebookUrl?: string;
+    /** Reddit community URL (optional) */
+    redditUrl?: string;
+    /** TikTok profile URL (optional) */
+    tiktokUrl?: string;
+}
+/**
+ * Data for creating a new pool
+ */
+export interface CreatePoolData {
+    /** Transaction ID */
+    txnId: string;
+    /** Image data (from upload response) */
+    image: Record<string, unknown>;
+    /** Token name (bad words filtered) */
+    tokenName: string;
+    /** Token symbol (bad words filtered) */
+    symbol: string;
+    /** Token description (bad words filtered) */
+    description: string;
+    /** Token amount */
+    amount: string;
+    /** Block number (optional - API may reject this field) */
+    blockNumber?: number;
+    /** Social media URLs (at least one required) */
+    urls: TokenUrls;
+    /** Initial buy amount - REMOVED: Backend rejects this parameter */
+    /** Vault address */
+    vaultAddress: string;
+    /** Creator address in backend format */
+    creatorAddress: AddressFormat;
+}
+/**
+ * Internal response from pool creation endpoint
+ */
+export interface InternalCreatePoolResponse {
+    /** Success status */
+    success: boolean;
+    /** Pool creation result */
+    data?: {
+        /** Pool details */
+        [key: string]: unknown;
+    };
+    /** Error message if creation failed */
+    message?: string;
+}
+/**
+ * Pool fetch type filter
+ */
+export type PoolFetchType = 'RECENT' | 'POPULAR' | 'RECORDINGS' | 'SECONDS_STREAMED';
+/**
+ * Public-facing options for fetching pools (uses lowercase for user convenience)
+ *
+ * @since 6.11.0 - Now extends SearchablePaginationOptions for DRY compliance
+ */
+export interface FetchPoolsOptions extends SearchablePaginationOptions {
+    /**
+     * Pool type filter
+     * - 'recent': Sort by creation date (default)
+     * - 'popular': Sort by bonding curve percentage
+     * - 'recordings': Sort by recordings count (highest first)
+     * - 'seconds_streamed': Sort by total seconds streamed (highest first)
+     * @since 5.8.0 - Added 'recordings' and 'seconds_streamed' options
+     */
+    type?: 'recent' | 'popular' | 'recordings' | 'seconds_streamed';
+    /**
+     * Filter pools with nextLiveStreamAt in the future (has upcoming shows)
+     * @since 5.7.0
+     */
+    hasUpcomingShows?: boolean;
+    /**
+     * Filter pools by stream language (ISO 639-1 code, e.g., "en", "es", "ja")
+     * @since 5.7.0
+     */
+    language?: string;
+    /**
+     * Filter pools that have streamed within the last N hours
+     * Examples: 24 for last day, 168 for last week, max 720 (30 days)
+     * @since 5.7.0
+     */
+    recentlyStreamed?: number;
+    /**
+     * Filter pools that have at least one recording (recordingsCount > 0)
+     * @since 5.8.0
+     */
+    hasRecordings?: boolean;
+    /**
+     * Filter pools by stream status (IDLE, ACTIVE, DISABLED)
+     * Used by overseers for CCTV monitoring grid
+     * @since 5.10.0
+     */
+    streamStatus?: 'idle' | 'active' | 'disabled';
+}
+/**
+ * Internal options for fetching pools (backend expects uppercase)
+ *
+ * @updated 8.1.0 - Migrated to cursor-based pagination
+ */
+export interface FetchPoolOptions extends SearchablePaginationOptions {
+    /** Pool type filter */
+    type?: PoolFetchType;
+    /** Filter pools with upcoming shows */
+    hasUpcomingShows?: boolean;
+    /** Filter pools by stream language */
+    language?: string;
+    /** Filter pools that have streamed within the last N hours */
+    recentlyStreamed?: number;
+    /** Filter pools that have at least one recording */
+    hasRecordings?: boolean;
+    /** Filter pools by stream status (IDLE, ACTIVE, DISABLED) */
+    streamStatus?: 'IDLE' | 'ACTIVE' | 'DISABLED';
+}
+/**
+ * Backend pool fetch options (adapted from SDK options)
+ * Uses cursor-based pagination
+ *
+ * @updated 8.1.0 - Migrated to cursor-based pagination (cursor/pageSize only)
+ */
+export interface BackendFetchPoolOptions {
+    /** Pool type filter */
+    type?: PoolFetchType;
+    /** Specific token name to fetch */
+    tokenName?: string;
+    /** Search query */
+    search?: string;
+    /** Filter pools with upcoming shows (backend expects string "true" or undefined) */
+    hasUpcomingShows?: string;
+    /** Filter pools by stream language (ISO 639-1 code) */
+    language?: string;
+    /** Filter pools that have streamed within the last N hours (backend expects string) */
+    recentlyStreamed?: string;
+    /** Filter pools that have at least one recording (backend expects string "true" or undefined) */
+    hasRecordings?: string;
+    /** Filter pools by stream status (IDLE, ACTIVE, DISABLED) */
+    streamStatus?: string;
+    /** Cursor for pagination as string (backend expects string, optional for first page) */
+    cursor?: string;
+    /** Items per page as string (backend expects string) */
+    pageSize: string;
+}
+/**
+ * Convenience asset URLs for token assets.
+ */
+export interface TokenAssetUrls {
+    image: string;
+    liveStream: string;
+    thumbnails: {
+        default: string;
+        webp: string;
+        ribbon: string;
+        live: string;
+        poster: string;
+    };
+    animated: {
+        gif: string;
+        webp: string;
+    };
+    storyboard: {
+        vtt: string;
+        json: string;
+        jpg: string;
+        png: string;
+        webp: string;
+    };
+}
+/**
+ * Pool data structure from backend
+ */
+export interface PoolData {
+    /** Pool identifier */
+    id: string;
+    /** Token name */
+    tokenName: string;
+    /** Token symbol */
+    symbol: string;
+    /** Token description */
+    description: string;
+    /** Token amount */
+    amount: string;
+    /** Creator address */
+    creatorAddress: string;
+    /** Vault address */
+    vaultAddress: string;
+    /** Creation timestamp */
+    createdAt: string;
+    /** Reverse bonding curve minimum fee portion (flattened, coalesced to "0" if null) */
+    reverseBondingCurveMinFeePortion?: string;
+    /** Reverse bonding curve maximum fee portion (flattened, coalesced to "0" if null) */
+    reverseBondingCurveMaxFeePortion?: string;
+    /** Boolean flag indicating if reverse bonding curve fees are non-zero */
+    hasReverseBondingCurveFee?: boolean;
+    /** Token image/logo URL */
+    image: string;
+    /** Convenience asset URLs */
+    assets?: TokenAssetUrls | null;
+    /** Project website URL */
+    websiteUrl: string;
+    /** Telegram channel URL */
+    telegramUrl: string;
+    /** Twitter profile URL */
+    twitterUrl: string;
+    /** Instagram profile URL */
+    instagramUrl: string;
+    /** Facebook page URL */
+    facebookUrl: string;
+    /** Reddit community URL */
+    redditUrl: string;
+    /** TikTok profile URL */
+    tiktokUrl: string;
+    /** Initial buy amount at pool creation */
+    initialBuyAmount: number;
+    /** Total trading volume (all-time) */
+    volume: string;
+    /** Trading volume in last 1 hour */
+    volume1h: string;
+    /** Current price in GALA */
+    galaPrice: string;
+    /** Total GALA tokens currently in pool */
+    galaInPool: string;
+    /** Current price in USD */
+    usdPrice: string;
+    /** Market capitalization in USD */
+    marketCapUsd: string;
+    /** Market capitalization in GALA */
+    marketCapGala: string;
+    /** Circulating supply of tokens */
+    circulatingSupply: string;
+    /** Change in supply (delta) */
+    deltaSupply: string;
+    /** Whether token has graduated to full DEX trading */
+    isGraduated: boolean;
+    /** Whether pool is finalized */
+    isFinalized: boolean;
+    /** Bonding curve completion percentage (0-100) */
+    bondingCurvePercentage: string;
+    /**
+     * Current viewer count for active streams
+     * @since 5.7.0
+     */
+    currentViewerCount?: number;
+    /**
+     * Highest viewer count during current/last stream session
+     * Reset when a new stream starts
+     * @since 5.7.0
+     */
+    peakViewerCount?: number;
+    /**
+     * Timestamp when stream status changed to ACTIVE (ISO 8601)
+     * Used to calculate stream duration
+     * @since 5.7.0
+     */
+    streamStartedAt?: string | null;
+    /**
+     * Timestamp when the pool last had an active stream (ISO 8601)
+     * Used for recentlyStreamed filter
+     * @since 5.7.0
+     */
+    lastStreamedAt?: string | null;
+    /**
+     * Count of recordings for this pool (synced from Mux)
+     * @since 5.8.0
+     */
+    recordingsCount?: number;
+    /**
+     * Cumulative seconds streamed across all stream sessions
+     * @since 5.8.0
+     */
+    totalSecondsStreamed?: number;
+    /**
+     * Playback ID for viewers (available when stream is active)
+     * @since 6.0.0
+     */
+    playbackId?: string | null;
+    /**
+     * Video aspect ratio (e.g., "16:9", "9:16")
+     * Captured from Mux when stream goes active
+     * @since 6.0.0
+     */
+    aspectRatio?: string;
+    /**
+     * Current stream status ('IDLE' | 'ACTIVE' | 'DISABLED')
+     * @since 6.0.0
+     */
+    muxStreamStatus?: StreamStatus;
+    /**
+     * Next scheduled live stream time (ISO 8601 string) or null if not set
+     * @since 6.0.0
+     */
+    nextLiveStreamAt?: string | null;
+    /**
+     * Stream language (ISO 639-1 code, e.g., "en", "es", "ja")
+     * @since 6.0.0
+     */
+    language?: string;
+    /**
+     * Whether streaming is enabled for this token
+     * @since 6.0.0
+     */
+    streamEnabled?: boolean;
+    /**
+     * Whether chat messages are enabled for this token
+     * @since 7.0.0
+     */
+    messagesEnabled?: boolean;
+    /**
+     * Whether comments are enabled for this token
+     * @since 7.0.0
+     */
+    commentsEnabled?: boolean;
+    /** Pool metadata */
+    [key: string]: unknown;
+}
+export interface ValidateTokenRequest {
+    /** Token name to validate */
+    tokenName?: string;
+    /** Token symbol to validate */
+    symbol?: string;
+}
+export interface ValidateTokenResponse {
+    /** Whether the token name is available */
+    nameAvailable: boolean;
+    /** Whether the token symbol is available */
+    symbolAvailable: boolean;
+    /** Whether the token name is blocklisted */
+    nameBlocklisted: boolean;
+    /** Whether the token symbol is blocklisted */
+    symbolBlocklisted: boolean;
+    /** List of validation error messages */
+    errors: string[];
+}
+/**
+ * Internal response from pool fetch endpoint
+ * Uses cursor-based pagination
+ *
+ * @updated 8.1.0 - Migrated to cursor-based pagination
+ */
+export interface InternalFetchPoolResponse {
+    /** Success status */
+    success: boolean;
+    /** HTTP status code */
+    status: number;
+    /** Error flag */
+    error: boolean;
+    /** Pool data */
+    data?: {
+        /** Pool array (legacy format) */
+        pools?: PoolData[];
+        /** Token data (actual backend response structure) */
+        tokens?: PoolData | PoolData[];
+        /** Total count of available items (backend returns "count", not "total") */
+        count?: number;
+        /** Total items (legacy field, not provided by backend) */
+        total?: number;
+        /** Cursor token for next page (from cursor-based pagination) */
+        nextCursor?: string;
+        /** Cursor token for previous page (from cursor-based pagination) */
+        prevCursor?: string;
+        /** Whether there are more pages (from cursor-based pagination) */
+        hasNextPage?: boolean;
+        /** Whether there are previous pages (from cursor-based pagination) */
+        hasPrevPage?: boolean;
+    };
+    /** Error message if fetch failed */
+    message?: string;
+}
+/**
+ * Clean result for fetching pools with offset-based pagination
+ *
+ * @since 6.6.0 - Refactored to use generic ListResult<T> pattern
+ * @since 8.1.0 - Changed to PaginatedResultWithMeta for proper offset-based pagination support
+ */
+export type PoolsResult = ListResult<PoolData>;
+/**
+ * Amount calculation type
+ */
+export type AmountType = 'NATIVE' | 'MEME';
+/**
+ * Amount calculation method
+ */
+export type AmountMethod = 'IN' | 'OUT';
+/**
+ * Options for amount calculation
+ */
+export interface GetAmountOptions {
+    /** Calculation type */
+    type: AmountType;
+    /** Calculation method */
+    method: AmountMethod;
+    /** Vault address */
+    vaultAddress: string;
+    /** Amount to calculate (decimal number as string) */
+    amount: string;
+}
+/**
+ * Internal response from amount calculation endpoint
+ */
+export interface InternalGetAmountResponse {
+    /** Success status */
+    success: boolean;
+    /** Status code */
+    status: number;
+    /** Error flag */
+    error: boolean;
+    /** Success message */
+    message: string;
+    /** Calculation result */
+    data?: {
+        /** Calculated amount */
+        calculatedQuantity: string;
+        /** Extra fees */
+        extraFees: {
+            /** Reverse bonding curve fee */
+            reverseBondingCurve: string;
+            /** Transaction fees */
+            transactionFees: string;
+        };
+    };
+}
+/**
+ * Clean result for amount calculations
+ */
+export interface AmountCalculationResult {
+    /** Calculated token amount */
+    amount: string;
+    /** Reverse bonding curve fee */
+    reverseBondingCurveFee: string;
+    /** Transaction fees */
+    transactionFee: string;
+    /** Gas fee (fixed at 1 GALA) */
+    gasFee: string;
+}
+/**
+ * Parameters for getting a trade quote via the backend proxy
+ *
+ * @since 9.1.0
+ */
+export interface TradeQuoteParams {
+    /** Token name (e.g. 'anime') */
+    tokenName: string;
+    /** Amount as a string decimal */
+    amount: string;
+    /** 'MEME' = meme/launchpad token, 'NATIVE' = GALA */
+    type: 'MEME' | 'NATIVE';
+    /** 'IN' = spend this amount, 'OUT' = receive this amount */
+    method: 'IN' | 'OUT';
+}
+/**
+ * Sale details result from the backend trading proxy
+ *
+ * @since 9.1.0
+ */
+export interface SaleDetailsResult {
+    /** Maximum token supply */
+    maxSupply: string;
+    /** Tokens currently listed for sale */
+    sellingTokenQuantity: string;
+    /** Native (GALA) tokens in the pool */
+    nativeTokenQuantity: string;
+    /** Current sale status (e.g. 'ACTIVE', 'PENDING', 'COMPLETED') */
+    saleStatus: string;
+    /** Unix timestamp when the sale starts (optional) */
+    saleStartTime?: number;
+    /** Milliseconds until launch (optional) */
+    timeUntilLaunch?: number;
+}
+/**
+ * Extended result for graduation calculations
+ *
+ * Includes the remaining token quantity needed to graduate the pool,
+ * in addition to the standard amount calculation fields.
+ *
+ * @since 4.0.2
+ */
+export interface GraduationCalculationResult extends AmountCalculationResult {
+    /**
+     * Remaining tokens to buy for graduation (token quantity, not GALA cost)
+     *
+     * This is the actual number of tokens that need to be purchased to reach
+     * the max supply and trigger graduation. Use this value as the `amount`
+     * parameter when calling `buy()` with `type: 'exact'`.
+     */
+    remainingTokens: string;
+}
+/**
+ * Direct GalaChain gateway response structure
+ * Used for all CallNativeToken/CallMemeToken endpoints
+ */
+export interface GalaChainGatewayResponse {
+    /** Success status */
+    Status: number;
+    /** Response message */
+    Message: string;
+    /** Raw response data */
+    Data: unknown;
+    /** Whether the request was successful */
+    IsSuccessful: boolean;
+    /** Timestamp of the response */
+    Timestamp: string;
+}
+/**
+ * GalaChain calculation result data structure
+ * This is the shape of the Data field in successful responses
+ */
+export interface GalaChainCalculationData {
+    /** Calculated quantity as decimal string */
+    calculatedQuantity: string;
+    /** Extra fees breakdown */
+    extraFees: {
+        /** Reverse bonding curve fee */
+        reverseBondingCurve: string;
+        /** Transaction fees */
+        transactionFees: string;
+    };
+}
+/**
+ * GalaChain endpoint mapping configuration
+ * Maps our internal type/method to GalaChain endpoints
+ */
+export interface GalaChainEndpointConfig {
+    /** Calculation type */
+    type: AmountType;
+    /** Calculation method */
+    method: AmountMethod;
+    /** Resulting endpoint path */
+    endpoint: string;
+}
+/**
+ * Available GalaChain calculation endpoints
+ */
+export declare const GALACHAIN_ENDPOINTS: {
+    readonly CALL_NATIVE_TOKEN_IN: "/api/asset/launchpad-contract/CallNativeTokenIn";
+    readonly CALL_NATIVE_TOKEN_OUT: "/api/asset/launchpad-contract/CallNativeTokenOut";
+    readonly CALL_MEME_TOKEN_IN: "/api/asset/launchpad-contract/CallMemeTokenIn";
+    readonly CALL_MEME_TOKEN_OUT: "/api/asset/launchpad-contract/CallMemeTokenOut";
+};
+/**
+ * Options for checking pool existence
+ * At least one of tokenName or symbol is required
+ */
+export interface CheckPoolOptions {
+    /** Token name to check (optional, but one of tokenName/symbol required) */
+    tokenName?: string;
+    /** Token symbol to check (optional, but one of tokenName/symbol required) */
+    symbol?: string;
+}
+/**
+ * Internal response from pool check endpoint
+ */
+export interface InternalCheckPoolResponse {
+    /** Success status */
+    success: boolean;
+    /** HTTP status code */
+    status: number;
+    /** Error flag */
+    error: boolean;
+    /** Check result */
+    data?: {
+        /** Whether pool exists (legacy field) */
+        exists?: boolean;
+        /** Whether symbol exists (actual API field) */
+        isSymbolExist?: boolean;
+        /** Whether name exists (actual API field) */
+        isNameExist?: boolean;
+        /** Pool details if exists */
+        pool?: PoolData;
+        /** Check metadata */
+        [key: string]: unknown;
+    };
+    /** Error message if check failed */
+    message?: string;
+}
+/**
+ * Token holder information
+ */
+export interface TokenHolder {
+    /** Wallet address in backend format (eth|40hex or service|...) */
+    address: string;
+    /** Token balance as decimal string (preserves full precision) */
+    balance: string;
+    /**
+     * Percentage of total supply held (0-100 scale)
+     * Calculated as: (balance / totalSupply) * 100
+     * Note: Calculated using BigNumber for precision, then converted to number for convenience
+     */
+    percentage: number;
+}
+/**
+ * Raw API holder data from backend
+ * This is the actual format returned by the /holders/:tokenName endpoint
+ * @internal - Not exported as it's only used for API response parsing
+ */
+interface RawHolderData {
+    /** Wallet address in backend format (owner field) */
+    owner: string;
+    /** Token quantity held */
+    quantity: string;
+}
+/**
+ * Internal response from token distribution endpoint
+ * @internal
+ * @see InternalApiResponse in common.ts for the shared type
+ */
+export type InternalGetTokenDistributionResponse = InternalApiResponse<RawHolderData[]>;
+/**
+ * Clean result for token distribution
+ */
+export interface TokenDistributionResult {
+    /** Array of top token holders */
+    holders: TokenHolder[];
+    /** Total supply of the token */
+    totalSupply: string;
+    /** Number of unique holders */
+    totalHolders: number;
+    /** Last updated timestamp */
+    lastUpdated: Date;
+}
+/**
+ * User's holder context for a specific token
+ * Used for user cards to show token-specific holder information
+ */
+export interface UserHolderContext {
+    /** Token name */
+    tokenName: string;
+    /** Normalized user address */
+    userAddress: string;
+    /** Token quantity held, or null if not a holder */
+    quantity: string | null;
+    /** Percentage of max supply held (0-100), or null if not a holder */
+    percentage: number | null;
+    /** Holder tier info, or null if not a holder */
+    holderTier: HolderTierInfo | null;
+    /** Whether this user created the token */
+    isCreator: boolean;
+    /** Holder rank (1 = largest holder), or null if not a holder */
+    rank: number | null;
+}
+/**
+ * Internal response from user holder context endpoint
+ * @internal
+ * @see InternalApiResponse in common.ts for the shared type
+ */
+export type InternalGetUserHolderContextResponse = InternalApiResponse<UserHolderContext>;
+/**
+ * Clean result for token badges
+ */
+export interface TokenBadgesResult {
+    /** Volume milestone badges */
+    volumeBadges: VolumeBadge[];
+    /** Engagement milestone badges */
+    engagementBadges: EngagementBadge[];
+}
+/**
+ * Graph data point with proper types
+ */
+export interface GraphDataResult {
+    /** Array of graph data points */
+    dataPoints: GraphDataPoint[];
+}
+/**
+ * Options for fetching graph data
+ */
+export interface GetGraphOptions {
+    /** Start timestamp (min 173000000) */
+    from: number;
+    /** End timestamp (min 173000000) */
+    to: number;
+    /** Data resolution (min 1) */
+    resolution: number;
+    /** Token name */
+    tokenName: string;
+}
+/**
+ * Graph data point
+ */
+export interface GraphDataPoint {
+    /** Timestamp */
+    timestamp: number;
+    /** Value at this time */
+    value: number;
+    /** Additional metrics */
+    [key: string]: unknown;
+}
+/**
+ * Internal response from graph data endpoint
+ */
+export interface InternalGetGraphResponse {
+    /** Success status */
+    success: boolean;
+    /** HTTP status code */
+    status: number;
+    /** Error flag */
+    error: boolean;
+    /** Graph data points */
+    data?: GraphDataPoint[];
+    /** Error message if fetch failed */
+    message?: string;
+}
+/**
+ * Reverse bonding curve configuration for token sales
+ *
+ * Defines the fee structure for the bonding curve:
+ * - `minFeePortion`: Minimum fee (>= 0.1, <= 0.5) - defaults to "0.1" (10%)
+ * - `maxFeePortion`: Maximum fee (>= minFee, <= 0.5) - defaults to "0.5" (50%)
+ *
+ * @example
+ * // Using defaults (recommended for most cases)
+ * // Omit this parameter to get: { minFeePortion: "0.1", maxFeePortion: "0.5" }
+ *
+ * @example
+ * // Custom configuration
+ * { minFeePortion: "0.2", maxFeePortion: "0.3" }
+ */
+export interface ReverseBondingCurveConfiguration {
+    /** Minimum fee portion as decimal string (>= 0.1, <= 0.5). Defaults to "0.1" if config omitted. */
+    minFeePortion: string;
+    /** Maximum fee portion as decimal string (>= minFee, <= 0.5). Defaults to "0.5" if config omitted. */
+    maxFeePortion: string;
+}
+/**
+ * Data for launching a new token using the bundle backend
+ * This provides a clean, user-friendly interface that handles complexity internally
+ */
+export interface LaunchTokenData {
+    /** Token name (lowercase, alphanumeric, max 10 chars) */
+    tokenName: string;
+    /** Token symbol (3-10 characters) */
+    tokenSymbol: string;
+    /** Token description (max 500 characters) */
+    tokenDescription: string;
+    /** Token image - can be File, Buffer, or URL string */
+    tokenImage?: File | Buffer | string;
+    /** Pre-buy quantity as decimal string (defaults to "0") */
+    preBuyQuantity?: string;
+    /** Website URL (optional) */
+    websiteUrl?: string;
+    /** Telegram channel URL (optional) */
+    telegramUrl?: string;
+    /** Twitter profile URL (optional) */
+    twitterUrl?: string;
+    /** Instagram profile URL (optional) */
+    instagramUrl?: string;
+    /** Facebook page URL (optional) */
+    facebookUrl?: string;
+    /** Reddit community URL (optional) */
+    redditUrl?: string;
+    /** TikTok profile URL (optional) */
+    tiktokUrl?: string;
+    /** Token category (defaults to 'Unit') */
+    tokenCategory?: string;
+    /** Token collection (defaults to 'Token') */
+    tokenCollection?: string;
+    /**
+     * Reverse bonding curve configuration (optional).
+     *
+     * Defaults to { minFeePortion: "0.1", maxFeePortion: "0.5" } if not provided.
+     * When provided, must satisfy: minFee >= 0.1, maxFee >= minFee, maxFee <= 0.5
+     */
+    reverseBondingCurveConfiguration?: ReverseBondingCurveConfiguration;
+    /**
+     * Unix timestamp (seconds) for when the sale should start.
+     * If omitted or undefined, the sale starts immediately upon creation.
+     * Must be a future timestamp (greater than current time).
+     */
+    saleStartTime?: number;
+    /** Optional private key override for this operation (format: '0x' + 64 hex characters) */
+    privateKey?: string;
+}
+/**
+ * Signed DTO for the bundle backend CreateSale operation
+ * This matches the exact format expected by the bundle backend
+ */
+export interface SignedDto {
+    /** Token name */
+    tokenName: string;
+    /** Token symbol */
+    tokenSymbol: string;
+    /** Token description */
+    tokenDescription: string;
+    /** Token image URL (from upload response) */
+    tokenImage: string;
+    /** Pre-buy quantity as decimal string */
+    preBuyQuantity: string;
+    /** Website URL (empty string if not provided) */
+    websiteUrl?: string;
+    /** Telegram URL (empty string if not provided) */
+    telegramUrl?: string;
+    /** Twitter URL (empty string if not provided) */
+    twitterUrl?: string;
+    /** Instagram URL (empty string if not provided) */
+    instagramUrl?: string;
+    /** Facebook URL (empty string if not provided) */
+    facebookUrl?: string;
+    /** Reddit URL (empty string if not provided) */
+    redditUrl?: string;
+    /** TikTok URL (empty string if not provided) */
+    tiktokUrl?: string;
+    /** Token category */
+    tokenCategory: string;
+    /** Token collection */
+    tokenCollection: string;
+    /** Reverse bonding curve configuration */
+    reverseBondingCurveConfiguration?: ReverseBondingCurveConfiguration;
+    /** Unique key for the operation */
+    uniqueKey: string;
+    /** EIP-712 signature */
+    signature: string;
+    /** EIP-712 types */
+    types: EIP712Types;
+    /** EIP-712 domain */
+    domain: EIP712Domain;
+    /** Personal sign prefix for message authentication */
+    prefix?: string;
+}
+/**
+ * Request payload for the bundle backend
+ */
+export interface BundleRequest {
+    /** Signed DTO with all required fields */
+    signedDto: SignedDto;
+    /** Array of string instructions for the operation */
+    stringsInstructions: string[];
+    /** Operation method - always 'CreateSale' for token creation */
+    method: 'CreateSale';
+}
+/**
+ * Internal response from the bundle backend LaunchToken endpoint
+ */
+export interface InternalLaunchTokenResponse {
+    /** Error status (false = success) */
+    error: boolean;
+    /** Transaction ID from successful creation */
+    data?: string;
+    /** Response message ("Transaction Received" for success) */
+    message?: string;
+}
+/**
+ * Volume badge information for tokens
+ * Indicates trading volume milestones achieved
+ */
+export interface VolumeBadge {
+    /** Badge name representing volume threshold */
+    badgeName: '1k' | '10k' | '100k' | '1M+';
+    /** Whether this badge level has been achieved */
+    isActive: boolean;
+}
+/**
+ * Engagement badge information for tokens
+ * Indicates community engagement milestones achieved
+ */
+export interface EngagementBadge {
+    /** Badge name representing engagement level */
+    badgeName: 'SPARK' | 'GATHERING' | 'CROWD' | 'MOVEMENT';
+    /** Whether this badge level has been achieved */
+    isActive: boolean;
+}
+/**
+ * Options for fetching token badges
+ */
+export interface GetTokenBadgesOptions {
+    /** Token name to get badges for */
+    tokenName: string;
+}
+/**
+ * Internal token badges data structure
+ * @internal
+ */
+export interface TokenBadgesData {
+    /** Volume milestone badges */
+    volumeBadge: VolumeBadge[];
+    /** Engagement milestone badges */
+    engagementBadge: EngagementBadge[];
+}
+/**
+ * Internal response from token badges endpoint
+ * @internal
+ * @see InternalApiResponse in common.ts for the shared type
+ */
+export type InternalGetTokenBadgesResponse = InternalApiResponse<TokenBadgesData>;
+/**
+ * Internal response from launch token fee endpoint
+ */
+export interface InternalLaunchTokenFeeResponse {
+    /** GalaChain response status (1 = success) */
+    Status: number;
+    /** Fee data */
+    Data: {
+        /** The GALA fee amount required to launch a token (e.g., 0.001) */
+        feeAmount: number;
+    };
+}
+/**
+ * Simplified token spot price data
+ * Contains current USD price for a token
+ */
+export interface TokenSpotPrice {
+    /** Token symbol (e.g., 'GALA', 'SILK', 'DRAGNRKTI') */
+    symbol: string;
+    /** Current USD price */
+    price: number;
+}
+/**
+ * Internal response from DEX API token price endpoint
+ * Contains raw token data with nested currentPrices
+ */
+export interface InternalTokenSpotPriceResponse {
+    /** Array of token objects with price data */
+    tokens: Array<{
+        /** Token symbol (e.g., 'GALA', 'SILK') */
+        symbol: string;
+        /** Current price information */
+        currentPrices?: {
+            /** Current USD price */
+            usd: number;
+            /** 24-hour price change percentage (as decimal) */
+            usd24hChange?: number;
+            /** 24-hour trading volume in USD */
+            usd24hVol?: number;
+            /** Market capitalization in USD */
+            usdMarketCap?: number;
+            /** Timestamp of last price update */
+            lastUpdatedAt: string;
+        };
+        /** Other token metadata we don't need */
+        [key: string]: unknown;
+    }>;
+}
+/**
+ * Comprehensive token details from DEX API platform
+ * Includes metadata, verification status, and trading information
+ *
+ * @since 3.18.0
+ */
+export interface TokenDetails {
+    /** Token image/logo URL */
+    image: string;
+    /** Token decimal precision */
+    decimals: number;
+    /** Token description */
+    description: string;
+    /** Token display name */
+    name: string;
+    /** Network identifier (e.g., 'GC' for GalaChain) */
+    network: string;
+    /** Token symbol (e.g., 'GALA', 'SILK') */
+    symbol: string;
+    /** Price symbol (if different from symbol) */
+    priceSymbol: string;
+    /** Whether price is sourced from external price provider */
+    priceIsKnownToExternalPriceSource: boolean;
+    /** Stringified token class key (pipe-delimited format) */
+    stringifiedTokenClassKey: string;
+    /** Token collection name */
+    collection: string;
+    /** Token category */
+    category: string;
+    /** Token type identifier */
+    type: string;
+    /** Additional key/identifier for the token */
+    additionalKey: string;
+    /** Whether token is swappable on DEX */
+    swappable: boolean;
+    /** Token channel/category (e.g., 'asset') */
+    channel: string;
+    /** Whether token is currently trending */
+    trending: boolean;
+    /** Whether token is verified */
+    verified: boolean;
+    /** Current price information by currency */
+    currentPrices: Record<string, unknown>;
+}
+/**
+ * Token metadata from GalaChain (authoritative source for token information)
+ *
+ * Contains essential token information directly from the blockchain.
+ * This is the source of truth for token symbols, decimals, and metadata.
+ *
+ * @since 3.22.0
+ */
+export interface GalaChainTokenDetails {
+    /** Token collection (e.g., 'Token', 'GALA') */
+    collection: string;
+    /** Token category (e.g., 'Unit') */
+    category: string;
+    /** Token type identifier */
+    type: string;
+    /** Additional key/network identifier (e.g., 'eth:0x...', 'none') */
+    additionalKey: string;
+    /** Token symbol - authoritative source from blockchain */
+    symbol: string;
+    /** Token decimal precision */
+    decimals: number;
+    /** Token display name */
+    name: string;
+    /** Token image/logo URL */
+    image: string;
+    /** Token description */
+    description: string;
+    /** Network identifier (e.g., 'ethereum', 'galachain') */
+    network: string;
+    /** Smart contract address (optional, may not be available for all tokens) */
+    contractAddress?: string;
+    /** Whether chat is enabled for this token (optional) */
+    chatEnabled?: boolean;
+}
+/**
+ * Internal response from DEX API token details endpoint
+ * @internal
+ */
+export interface InternalTokenDetailsResponse {
+    /** Array of token details */
+    tokens: TokenDetails[];
+}
+/**
+ * Token class with supply information from GalaChain
+ *
+ * Represents a token and its current supply metrics directly from the blockchain.
+ * This is the authoritative source for token supply data.
+ *
+ * @since 3.32.0
+ */
+export interface TokenClassWithSupply {
+    /** Token collection (e.g., 'Token', 'GALA') */
+    collection: string;
+    /** Token category (e.g., 'Unit') */
+    category: string;
+    /** Token type identifier (e.g., 'GALA', 'none') */
+    type: string;
+    /** Additional key/network identifier (e.g., 'eth:0x...', 'none') */
+    additionalKey: string;
+    /** Token symbol (e.g., 'GALA', 'GUSDC') */
+    symbol: string;
+    /** Token decimal precision (e.g., 8 for GALA) */
+    decimals: number;
+    /** Token display name */
+    name: string;
+    /** Total supply in circulation (as string with decimals) */
+    totalSupply: string;
+    /** Maximum possible supply (as string with decimals) */
+    maxSupply: string;
+    /** Total amount burned (as string with decimals) */
+    totalBurned: string;
+    /** Known mint supply (as string with decimals) */
+    knownMintSupply: string;
+    /** Known mint allowance supply (as string with decimals) */
+    knownMintAllowanceSupply: string;
+    /** Array of authorities managing the token (optional) */
+    authorities?: Array<{
+        /** Authority address */
+        address?: string;
+        /** Authority role/type */
+        role?: string;
+    }>;
+    /** Additional metadata that may be present (use type guards when accessing) */
+    [key: string]: unknown;
+}
+/**
+ * Internal response from GalaChain FetchTokenClassesWithSupply endpoint
+ * @internal
+ */
+export interface InternalFetchTokenClassesWithSupplyResponse {
+    /** Status code from GalaChain (1 = success) */
+    Status: number;
+    /** Array of token classes with supply information */
+    Data?: TokenClassWithSupply[];
+    /** Error message if request failed */
+    Message?: string;
+    /** Additional response metadata */
+    [key: string]: unknown;
+}
+/**
+ * DEX leaderboard season with time-based ranges
+ *
+ * Represents a competitive season with specific start and end dates.
+ * Use the season ID to fetch leaderboards and rankings.
+ *
+ * @category DEX Leaderboard
+ * @since 3.X.0
+ */
+export interface DexSeason {
+    /** Season identifier (used in leaderboard queries) */
+    id: number;
+    /** Display name (e.g., "Season 1") */
+    name: string;
+    /** Season start timestamp (parsed to Date object) */
+    start: Date;
+    /** Season end timestamp (parsed to Date object) */
+    end: Date;
+    /** Rules configuration reference */
+    rulesId: number;
+}
+/**
+ * Raw API response for seasons endpoint (before transformation)
+ * @internal
+ */
+export type InternalSeasonsResponse = Array<{
+    id: number;
+    name: string;
+    start: string;
+    end: string;
+    rules_id: number;
+}>;
+/**
+ * Achievement title earned by leaderboard participant
+ *
+ * Represents a mastery achievement earned through liquidity provision or trading.
+ * Order indicates tier level (higher = more advanced).
+ *
+ * @category DEX Leaderboard
+ * @since 3.X.0
+ */
+export interface MasteryTitle {
+    /** Achievement title name (e.g., "Flow Enabler", "Elite Trader") */
+    name: string;
+    /** Category of achievement: liquidity provision or trading */
+    type: 'liquidity' | 'trade';
+    /** Tier level (1 = entry level, higher = more advanced) */
+    order: number;
+}
+/**
+ * Single leaderboard entry with ranking and XP metrics
+ *
+ * Represents a participant's position and achievements in the leaderboard.
+ *
+ * @category DEX Leaderboard
+ * @since 3.X.0
+ */
+export interface LeaderboardEntry {
+    /** Wallet identifier (format: client|id or eth|address) */
+    wallet: string;
+    /** Leaderboard rank position (1-100) */
+    rank: number;
+    /** Total XP earned (numeric string) */
+    totalXp: string;
+    /** Reward distribution percentage (numeric string) */
+    distributionPercent: string;
+    /** XP earned from liquidity provision (numeric string) */
+    liquidityXp: string;
+    /** XP earned from trading activity (numeric string) */
+    tradingXp: string;
+    /** Array of achievement titles earned */
+    masteryTitles: MasteryTitle[];
+}
+/**
+ * Raw API response for leaderboard endpoint (before transformation)
+ * @internal
+ */
+export interface InternalLeaderboardResponse {
+    leaderboard: Array<{
+        wallet: string;
+        rank: number;
+        total_xp: string;
+        distribution_percent: string;
+        liquidity_xp: string;
+        trading_xp: string;
+        mastery_titles: Array<{
+            name: string;
+            type: string;
+            order: number;
+        }>;
+    }>;
+}
+/**
+ * Complete leaderboard result with all entries and metadata
+ *
+ * Non-paginated response containing all leaderboard entries (typically 100 participants)
+ * with their rankings, XP metrics, and achievements.
+ *
+ * @category DEX Leaderboard
+ * @since 3.X.0
+ */
+export interface LeaderboardResult {
+    /** All leaderboard entries (1-100) sorted by rank */
+    entries: LeaderboardEntry[];
+    /** Season identifier for these rankings */
+    seasonId: number;
+    /** Total number of entries on the leaderboard */
+    totalEntries: number;
+}
+/**
+ * DEX aggregated volume summary with trend metrics
+ * @category DEX Analytics
+ * @since 4.0.0
+ */
+export interface DexAggregatedVolumeSummary {
+    /** 1-day total volume (USD) */
+    volume1d: number;
+    /** 1-day volume % change (-0.15 = -15%, 0.05 = +5%) */
+    volume1dDelta: number;
+    /** 7-day total volume (USD) */
+    volume7d: number;
+    /** 7-day volume % change */
+    volume7dDelta: number;
+    /** 30-day total volume (USD) */
+    volume30d: number;
+    /** 30-day volume % change */
+    volume30dDelta: number;
+}
+/**
+ * Raw API response for DEX volume summary
+ * @internal
+ */
+export interface InternalDexVolumeSummaryResponse {
+    id: number;
+    volume1d: number;
+    volume1dDelta: number;
+    volume7d: number;
+    volume7dDelta: number;
+    volume30d: number;
+    volume30dDelta: number;
+}
+export {};
+//# sourceMappingURL=launchpad.dto.d.ts.map