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

package/dist/types/pool-state-delta.dto.d.ts

@@ -0,0 +1,246 @@
+/**
+ * Pool State Delta Type Definitions
+ *
+ * Contract definitions for pool state management and swap delta calculations.
+ * These types enable efficient tracking of pool state changes without full refetches.
+ *
+ * @packageDocumentation
+ */
+import type { Pool, TickData } from '@gala-chain/dex';
+/**
+ * Data extracted from GalaChain swap transaction events
+ *
+ * Represents the raw data available from a completed swap transaction on-chain.
+ * Used as input to calculate the delta changes to pool state.
+ *
+ * @category Pool State
+ */
+export interface SwapEventData {
+    /** Unique transaction identifier (UUID format) */
+    transactionId: string;
+    /** Transaction timestamp (milliseconds since epoch) */
+    timestamp: number;
+    /** Amount specified in the swap (can be negative for exactOutput swaps) */
+    amountSpecified: string;
+    /** True if swapping token0 for token1, false if swapping token1 for token0 */
+    zeroForOne: boolean;
+    /** True for exact input swaps, false for exact output swaps */
+    exactInput: boolean;
+    /**
+     * Optional: Actual amount0 from chain (for validation)
+     * Negative values indicate token0 was spent, positive indicates received
+     */
+    actualAmount0?: string;
+    /**
+     * Optional: Actual amount1 from chain (for validation)
+     * Negative values indicate token1 was spent, positive indicates received
+     */
+    actualAmount1?: string;
+    /**
+     * Optional: Final sqrtPrice from chain (for validation)
+     * Used to detect drift between calculated and actual pool state
+     */
+    actualSqrtPrice?: string;
+}
+/**
+ * Complete result of applying a swap delta to cached pool state
+ *
+ * Contains all state changes from processing a swap event, including updated
+ * pool parameters, tick data modifications, token amounts, fees, and metadata.
+ *
+ * @category Pool State
+ */
+export interface SwapDeltaResult {
+    /** Updated pool object with new sqrtPrice, liquidity, and tick */
+    updatedPool: Pool;
+    /**
+     * Only ticks that changed during the swap
+     * Record key is tick index as string, value is updated TickData
+     */
+    updatedTicks: Record<string, TickData>;
+    /**
+     * Token0 amount in the swap
+     * Negative if token0 was spent, positive if received
+     */
+    amount0: BigNumber;
+    /**
+     * Token1 amount in the swap
+     * Negative if token1 was spent, positive if received
+     */
+    amount1: BigNumber;
+    /** Fee collected in token0 during the swap */
+    feeAmount0: BigNumber;
+    /** Fee collected in token1 during the swap */
+    feeAmount1: BigNumber;
+    /**
+     * Array of tick indices that were crossed during the swap
+     * Ticks are crossed when price moves through a liquidity boundary
+     */
+    ticksCrossed: number[];
+    /** Calculation metadata and diagnostics */
+    metadata: {
+        /** Time taken to calculate applySwapDelta (milliseconds) */
+        calculationTimeMs: number;
+        /** Number of iterations through the swap calculation loop */
+        swapSteps: number;
+        /** True if price reached sqrtPriceLimit before consuming all input */
+        priceHitLimit: boolean;
+        /**
+         * Optional: Drift percentage from actual on-chain data
+         * Only present if validation data (actualAmount0/1, actualSqrtPrice) was provided
+         * Represents % difference between calculated and actual values
+         */
+        driftPercentage?: number;
+    };
+}
+/**
+ * Tracking information for cached pool state
+ *
+ * Maintains metadata about the pool cache state to determine when
+ * a full refetch is necessary vs. when delta updates are sufficient.
+ *
+ * @category Pool State
+ */
+export interface PoolStateMetadata {
+    /**
+     * Timestamp of last full fetchCompositePoolData call
+     * Milliseconds since epoch
+     */
+    lastFullRefetch: number;
+    /**
+     * Count of swap deltas applied since last refetch
+     * Used to trigger refetch after N swaps to prevent drift accumulation
+     */
+    swapsSinceRefetch: number;
+    /**
+     * Accumulated drift percentage across all swaps since refetch
+     * Sum of absolute drift values from validation checks
+     */
+    cumulativeDrift: number;
+    /**
+     * Transaction IDs we've already processed
+     * Prevents duplicate processing of the same swap event
+     */
+    processedTransactions: string[];
+    /**
+     * Hash of critical pool state for validation
+     * Used to detect external modifications to pool state
+     * Typically hash of: sqrtPrice + liquidity + tick + token0Balance + token1Balance
+     */
+    stateHash: string;
+}
+/**
+ * Result of pool state validation checks
+ *
+ * Indicates whether cached pool state is still reliable or if a refetch is needed.
+ * Provides diagnostic information about detected drift and validation failures.
+ *
+ * @category Pool State
+ */
+export interface PoolStateValidationResult {
+    /** True if cached pool state passes validation checks */
+    isValid: boolean;
+    /**
+     * Percentage difference detected between calculated and actual values
+     * 0.001 = 0.1% drift
+     */
+    driftPercentage: number;
+    /** True if a full refetch is recommended */
+    shouldRefetch: boolean;
+    /**
+     * Reason for refetch recommendation (if shouldRefetch is true)
+     * - 'drift': Accumulated drift exceeded threshold
+     * - 'swap-count': Too many swaps applied since refetch
+     * - 'time-elapsed': Too much time passed since refetch
+     * - 'tick-mismatch': Tick and price are inconsistent
+     * - 'manual': Manual validation failure
+     * - 'missing-tick-data': Required tick data not in cache
+     */
+    refetchReason?: 'drift' | 'swap-count' | 'time-elapsed' | 'tick-mismatch' | 'manual' | 'missing-tick-data';
+    /**
+     * List of specific validation failures detected
+     * Empty array if no failures
+     */
+    validationErrors: string[];
+}
+/**
+ * Internal state tracked during swap calculation
+ *
+ * Represents the mutable state that changes as the swap progresses
+ * through multiple tick boundaries.
+ *
+ * @internal
+ * @category Pool State
+ */
+export interface InternalSwapState {
+    /** Current square root price (Q64.96 format) */
+    sqrtPrice: BigNumber;
+    /** Current available liquidity */
+    liquidity: BigNumber;
+    /** Current tick index */
+    tick: number;
+    /**
+     * Remaining amount of the specified token to swap
+     * Decreases as swap progresses
+     */
+    amountSpecifiedRemaining: BigNumber;
+    /**
+     * Accumulated output amount calculated so far
+     * Increases as swap progresses
+     */
+    amountCalculated: BigNumber;
+    /** Global fee growth for token0 (or token1 depending on direction) */
+    feeGrowthGlobalX: BigNumber;
+    /** Accumulated protocol fees */
+    protocolFee: BigNumber;
+}
+/**
+ * Result of a single swap step calculation
+ *
+ * Represents the changes from moving from one tick boundary to the next
+ * (or to the target price if reached first).
+ *
+ * @internal
+ * @category Pool State
+ */
+export interface SwapStepResult {
+    /** Square root price at the start of this step */
+    sqrtPriceStart: BigNumber;
+    /** Next tick boundary index */
+    tickNext: number;
+    /** Square root price at the next tick (or target price) */
+    sqrtPriceNext: BigNumber;
+    /** True if the next tick boundary is initialized with liquidity */
+    initialised: boolean;
+    /** Output token amount for this step */
+    amountOut: BigNumber;
+    /** Input token amount for this step */
+    amountIn: BigNumber;
+    /** Fee amount collected in this step */
+    feeAmount: BigNumber;
+}
+/**
+ * Event data for crossing a tick boundary
+ *
+ * Tracks liquidity changes when price moves through a tick,
+ * which affects available liquidity for subsequent swap steps.
+ *
+ * @internal
+ * @category Pool State
+ */
+export interface TickCrossingEvent {
+    /** Tick index that was crossed */
+    tick: number;
+    /** Direction of crossing ('up' = price increased, 'down' = price decreased) */
+    direction: 'up' | 'down';
+    /**
+     * Net liquidity change at this tick
+     * Positive when crossing up, negative when crossing down
+     */
+    liquidityNet: BigNumber;
+    /** Liquidity before crossing this tick */
+    liquidityBefore: BigNumber;
+    /** Liquidity after crossing this tick */
+    liquidityAfter: BigNumber;
+}
+//# sourceMappingURL=pool-state-delta.dto.d.ts.map

package/dist/types/pool-state-delta.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pool-state-delta.dto.d.ts","sourceRoot":"","sources":["../../src/types/pool-state-delta.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEtD;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC5B,kDAAkD;IAClD,aAAa,EAAE,MAAM,CAAC;IAEtB,uDAAuD;IACvD,SAAS,EAAE,MAAM,CAAC;IAElB,2EAA2E;IAC3E,eAAe,EAAE,MAAM,CAAC;IAExB,8EAA8E;IAC9E,UAAU,EAAE,OAAO,CAAC;IAEpB,+DAA+D;IAC/D,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,WAAW,EAAE,IAAI,CAAC;IAElB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAEvC;;;OAGG;IACH,OAAO,EAAE,SAAS,CAAC;IAEnB;;;OAGG;IACH,OAAO,EAAE,SAAS,CAAC;IAEnB,8CAA8C;IAC9C,UAAU,EAAE,SAAS,CAAC;IAEtB,8CAA8C;IAC9C,UAAU,EAAE,SAAS,CAAC;IAEtB;;;OAGG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB,2CAA2C;IAC3C,QAAQ,EAAE;QACR,4DAA4D;QAC5D,iBAAiB,EAAE,MAAM,CAAC;QAE1B,6DAA6D;QAC7D,SAAS,EAAE,MAAM,CAAC;QAElB,sEAAsE;QACtE,aAAa,EAAE,OAAO,CAAC;QAEvB;;;;WAIG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAEhC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,yBAAyB;IACxC,yDAAyD;IACzD,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB,4CAA4C;IAC5C,aAAa,EAAE,OAAO,CAAC;IAEvB;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,cAAc,GAAG,eAAe,GAAG,QAAQ,GAAG,mBAAmB,CAAC;IAE3G;;;OAGG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC,gDAAgD;IAChD,SAAS,EAAE,SAAS,CAAC;IAErB,kCAAkC;IAClC,SAAS,EAAE,SAAS,CAAC;IAErB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,wBAAwB,EAAE,SAAS,CAAC;IAEpC;;;OAGG;IACH,gBAAgB,EAAE,SAAS,CAAC;IAE5B,sEAAsE;IACtE,gBAAgB,EAAE,SAAS,CAAC;IAE5B,gCAAgC;IAChC,WAAW,EAAE,SAAS,CAAC;CACxB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc;IAC7B,kDAAkD;IAClD,cAAc,EAAE,SAAS,CAAC;IAE1B,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IAEjB,2DAA2D;IAC3D,aAAa,EAAE,SAAS,CAAC;IAEzB,mEAAmE;IACnE,WAAW,EAAE,OAAO,CAAC;IAErB,wCAAwC;IACxC,SAAS,EAAE,SAAS,CAAC;IAErB,uCAAuC;IACvC,QAAQ,EAAE,SAAS,CAAC;IAEpB,wCAAwC;IACxC,SAAS,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IAEb,+EAA+E;IAC/E,SAAS,EAAE,IAAI,GAAG,MAAM,CAAC;IAEzB;;;OAGG;IACH,YAAY,EAAE,SAAS,CAAC;IAExB,0CAA0C;IAC1C,eAAe,EAAE,SAAS,CAAC;IAE3B,yCAAyC;IACzC,cAAc,EAAE,SAAS,CAAC;CAC3B"}

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

@@ -0,0 +1,111 @@
+/**
+ * Pool Data Transfer Objects
+ *
+ * Types for pool/token data structures used in API responses
+ * and internal SDK operations.
+ *
+ * @module types/pool.dto
+ */
+/**
+ * Pool sale status values
+ * - 'OnSale' - Token is actively trading on bonding curve
+ * - 'Finished' - Token has graduated to DEX
+ * - 'Paused' - Trading temporarily paused
+ * - 'Upcoming' - Sale is scheduled but not yet started (has future saleStartTime)
+ */
+export type PoolSaleStatus = 'OnSale' | 'Finished' | 'Paused' | 'Upcoming';
+/**
+ * Launchpad pool data structure
+ *
+ * Represents a token pool in the launchpad system.
+ * Used for pool listings and basic pool information.
+ */
+export interface LaunchpadPool {
+    /** Token name (lowercase identifier) */
+    tokenName: string;
+    /** Token symbol (uppercase ticker) */
+    symbol: string;
+    /** Token description */
+    description?: string;
+    /** Token image URL */
+    image?: string;
+    /** Total token supply */
+    totalSupply: string;
+    /** Current circulating supply */
+    currentSupply: string;
+    /** Current token price */
+    price: string;
+    /** Market capitalization */
+    marketCap: string;
+    /** Pool creator address */
+    creatorAddress: string;
+    /** Current sale status */
+    saleStatus: PoolSaleStatus;
+    /** Unix timestamp (seconds) when the sale is scheduled to start (absent if immediate) */
+    saleStartTime?: number;
+    /** Pool creation timestamp (ISO 8601) */
+    createdAt: string;
+    /** Website URL */
+    websiteUrl?: string;
+    /** Twitter URL */
+    twitterUrl?: string;
+    /** Telegram URL */
+    telegramUrl?: string;
+    /** Instagram URL */
+    instagramUrl?: string;
+    /** Facebook URL */
+    facebookUrl?: string;
+    /** Reddit URL */
+    redditUrl?: string;
+    /** TikTok URL */
+    tiktokUrl?: string;
+}
+/**
+ * Detailed pool response from API
+ *
+ * Extended pool information including bonding curve configuration
+ * and remaining token data.
+ */
+export interface PoolDetailsResponse {
+    /** Token name (lowercase identifier) */
+    tokenName: string;
+    /** Token symbol (uppercase ticker) */
+    symbol: string;
+    /** Token description */
+    description?: string;
+    /** Token image URL */
+    image?: string;
+    /** Maximum token supply */
+    maxSupply: string;
+    /** Current circulating supply */
+    currentSupply: string;
+    /** Remaining tokens available for purchase */
+    remainingTokens: string;
+    /** Current sale status */
+    saleStatus: PoolSaleStatus;
+    /** Unix timestamp (seconds) when the sale is scheduled to start (absent if immediate) */
+    saleStartTime?: number;
+    /** Pool creator address */
+    creatorAddress: string;
+    /** Pool creation timestamp (ISO 8601) */
+    createdAt: string;
+    /** Website URL */
+    websiteUrl?: string;
+    /** Twitter URL */
+    twitterUrl?: string;
+    /** Telegram URL */
+    telegramUrl?: string;
+    /** Instagram URL */
+    instagramUrl?: string;
+    /** Facebook URL */
+    facebookUrl?: string;
+    /** Reddit URL */
+    redditUrl?: string;
+    /** TikTok URL */
+    tiktokUrl?: string;
+    /** Reverse bonding curve maximum fee factor (as string, e.g., "0.5") */
+    reverseBondingCurveMaxFeeFactor?: string;
+    /** Reverse bonding curve minimum fee factor (as string, e.g., "0.1") */
+    reverseBondingCurveMinFeeFactor?: string;
+}
+//# sourceMappingURL=pool.dto.d.ts.map

package/dist/types/pool.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pool.dto.d.ts","sourceRoot":"","sources":["../../src/types/pool.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,cAAc,EAAE,MAAM,CAAC;IACvB,0BAA0B;IAC1B,UAAU,EAAE,cAAc,CAAC;IAC3B,yFAAyF;IACzF,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,8CAA8C;IAC9C,eAAe,EAAE,MAAM,CAAC;IACxB,0BAA0B;IAC1B,UAAU,EAAE,cAAc,CAAC;IAC3B,yFAAyF;IACzF,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2BAA2B;IAC3B,cAAc,EAAE,MAAM,CAAC;IACvB,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wEAAwE;IACxE,+BAA+B,CAAC,EAAE,MAAM,CAAC;IACzC,wEAAwE;IACxE,+BAA+B,CAAC,EAAE,MAAM,CAAC;CAC1C"}

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

@@ -0,0 +1,165 @@
+/**
+ * Data Transfer Objects for Price History Operations
+ *
+ * Types for fetching historical price snapshots from DEX Backend API.
+ * Price history is only available for DEX tokens and requires Node.js environment.
+ *
+ * @category Price History
+ * @since 3.13.0
+ */
+import type { TokenId } from './common.js';
+/**
+ * Sort order for price history results
+ * @since 3.13.0
+ */
+export type PriceSortOrder = 'ASC' | 'DESC';
+/**
+ * Options for fetching price history
+ *
+ * Supports flexible token identification via either:
+ * - `tokenName`: Simple launchpad token name (e.g., "demonkpop", "shoewars")
+ * - `tokenId`: Full token class key in format "collection|category|type|additionalKey"
+ *
+ * Exactly one of `tokenName` or `tokenId` must be provided (mutually exclusive).
+ *
+ * When `tokenName` is provided, the SDK automatically resolves it to the full tokenId
+ * by calling fetchPoolDetails() internally.
+ *
+ * @since 3.13.0 (tokenId parameter)
+ * @since 3.20.0 (tokenName parameter added)
+ */
+export interface FetchPriceHistoryOptions {
+    /** Simple token name for convenience (e.g., "demonkpop") - automatically resolves to full tokenId */
+    tokenName?: string;
+    /** Flexible token identifier - accepts string, TokenClassKey, or TokenInstanceKey */
+    tokenId?: TokenId;
+    /** Start date for filtering price snapshots (optional, defaults to 30 days ago) */
+    from?: Date;
+    /** End date for filtering price snapshots (optional, defaults to now) */
+    to?: Date;
+    /** Sort order for results (default: DESC for newest-first) */
+    sortOrder?: PriceSortOrder;
+    /** Cursor token for fetching the next page (omit for first page) - for cursor-based pagination */
+    cursor?: string;
+    /** Page size for pagination (defaults to 10, max 50 - DEX Backend API constraint) */
+    pageSize?: number;
+    /** Offset into results (0-based, defaults to 0) - DEPRECATED, use cursor/pageSize instead */
+    offset?: number;
+    /** Number of items per page (DEPRECATED, use pageSize instead) */
+    limit?: number;
+}
+/**
+ * Single price snapshot from the database
+ *
+ * Represents a point-in-time price record for a token.
+ *
+ * @since 3.13.0
+ */
+export interface PriceSnapshot {
+    /** Token price as a decimal string (uses BigNumber-safe precision) */
+    price: string;
+    /** Timestamp of the price snapshot (created_at from database) */
+    timestamp: Date;
+    /** Token ID in pipe-delimited format: "collection|category|type|additionalKey" */
+    tokenId: string;
+}
+/**
+ * Result of fetching price history with pagination metadata
+ *
+ * Follows the same pagination pattern as other pageable queries in the SDK.
+ *
+ * @since 3.13.0
+ * @example
+ * ```typescript
+ * // Object format
+ * const result = await sdk.fetchPriceHistory({
+ *   tokenId: {
+ *     collection: 'GUSDC',
+ *     category: 'Unit',
+ *     type: 'none',
+ *     additionalKey: 'none'
+ *   },
+ *   from: new Date('2024-01-01'),
+ *   to: new Date('2024-01-31'),
+ *   page: 1,
+ *   limit: 20
+ * });
+ *
+ * // String format
+ * const result = await sdk.fetchPriceHistory({
+ *   tokenId: 'GUSDC|Unit|none|none',
+ *   page: 1,
+ *   limit: 20
+ * });
+ *
+ * console.log(`Found ${result.snapshots.length} snapshots`);
+ * result.snapshots.forEach(snap => {
+ *   console.log(`${snap.tokenId}: $${snap.price} at ${snap.timestamp}`);
+ * });
+ * console.log(`Total: ${result.total}, Page ${result.page} of ${result.totalPages}`);
+ * ```
+ */
+export interface PriceHistoryResult {
+    /** Array of price snapshots for the requested period */
+    snapshots: PriceSnapshot[];
+    /** Current page number (1-based) */
+    page: number;
+    /** Number of items per page */
+    limit: number;
+    /** Total number of snapshots matching the filter */
+    total: number;
+    /** Total number of pages available */
+    totalPages: number;
+    /** Whether there are more pages after this one */
+    hasNext: boolean;
+    /** Whether there are pages before this one */
+    hasPrevious: boolean;
+}
+/**
+ * DEX Backend API response format for price oracle /price-oracle/fetch-price endpoint
+ *
+ * @internal
+ * @since 3.16.0
+ */
+export interface DexPriceOracleResponse {
+    /** HTTP status code */
+    status: number;
+    /** Response message */
+    message: string;
+    /** Error flag */
+    error: boolean;
+    /** Response data containing price snapshots and pagination metadata */
+    data: {
+        /** Array of price snapshots */
+        data: Array<{
+            /** Unique identifier for the snapshot record */
+            id: number;
+            /** Token collection identifier */
+            collection: string;
+            /** Token category identifier */
+            category: string;
+            /** Token type identifier */
+            type: string;
+            /** Additional key for token identification */
+            additionalKey: string;
+            /** Token price as decimal string (USD) */
+            price: string;
+            /** Snapshot creation timestamp (ISO 8601) */
+            createdAt: string;
+            /** Snapshot update timestamp (ISO 8601) */
+            updatedAt: string;
+        }>;
+        /** Pagination metadata */
+        meta: {
+            /** Total number of items matching the filter */
+            totalItems: number;
+            /** Current page number (1-based) */
+            currentPage: number;
+            /** Number of items per page */
+            pageSize: number;
+            /** Total number of available pages */
+            totalPages: number;
+        };
+    };
+}
+//# sourceMappingURL=priceHistory.dto.d.ts.map

package/dist/types/priceHistory.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"priceHistory.dto.d.ts","sourceRoot":"","sources":["../../src/types/priceHistory.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAE3C;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,CAAC;AAE5C;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,wBAAwB;IACvC,qGAAqG;IACrG,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qFAAqF;IACrF,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mFAAmF;IACnF,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,yEAAyE;IACzE,EAAE,CAAC,EAAE,IAAI,CAAC;IACV,8DAA8D;IAC9D,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,kGAAkG;IAClG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qFAAqF;IACrF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6FAA6F;IAC7F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,sEAAsE;IACtE,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,SAAS,EAAE,IAAI,CAAC;IAChB,kFAAkF;IAClF,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,WAAW,kBAAkB;IACjC,wDAAwD;IACxD,SAAS,EAAE,aAAa,EAAE,CAAC;IAC3B,oCAAoC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAC;IACjB,8CAA8C;IAC9C,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,uEAAuE;IACvE,IAAI,EAAE;QACJ,+BAA+B;QAC/B,IAAI,EAAE,KAAK,CAAC;YACV,gDAAgD;YAChD,EAAE,EAAE,MAAM,CAAC;YACX,kCAAkC;YAClC,UAAU,EAAE,MAAM,CAAC;YACnB,gCAAgC;YAChC,QAAQ,EAAE,MAAM,CAAC;YACjB,4BAA4B;YAC5B,IAAI,EAAE,MAAM,CAAC;YACb,8CAA8C;YAC9C,aAAa,EAAE,MAAM,CAAC;YACtB,0CAA0C;YAC1C,KAAK,EAAE,MAAM,CAAC;YACd,6CAA6C;YAC7C,SAAS,EAAE,MAAM,CAAC;YAClB,2CAA2C;YAC3C,SAAS,EAAE,MAAM,CAAC;SACnB,CAAC,CAAC;QACH,0BAA0B;QAC1B,IAAI,EAAE;YACJ,gDAAgD;YAChD,UAAU,EAAE,MAAM,CAAC;YACnB,oCAAoC;YACpC,WAAW,EAAE,MAAM,CAAC;YACpB,+BAA+B;YAC/B,QAAQ,EAAE,MAAM,CAAC;YACjB,sCAAsC;YACtC,UAAU,EAAE,MAAM,CAAC;SACpB,CAAC;KACH,CAAC;CACH"}

package/dist/types/restricted-names.dto.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Restricted Token Names API DTOs (v7.0.0+)
+ *
+ * Simplified API for managing restricted token names.
+ * Stores a single newline-separated text blob of restricted words.
+ *
+ * @since 7.0.0
+ */
+/**
+ * Response from GET /v1/restricted-token-names
+ */
+export interface GetRestrictedNamesResponse {
+    /** Newline-separated list of restricted token name words */
+    content: string;
+}
+/**
+ * Request body for PUT /v1/restricted-token-names
+ */
+export interface UpdateRestrictedNamesRequest {
+    /** Newline-separated list of restricted token name words */
+    content: string;
+}
+/**
+ * Response from PUT /v1/restricted-token-names
+ */
+export interface UpdateRestrictedNamesResponse {
+    /** Success confirmation */
+    success: true;
+}
+/**
+ * Result type for getting restricted names
+ */
+export type GetRestrictedNamesResult = {
+    success: true;
+    data: GetRestrictedNamesResponse;
+} | {
+    success: false;
+    error: string;
+};
+/**
+ * Result type for updating restricted names
+ */
+export type UpdateRestrictedNamesResult = {
+    success: true;
+    data: UpdateRestrictedNamesResponse;
+} | {
+    success: false;
+    error: string;
+};
+//# sourceMappingURL=restricted-names.dto.d.ts.map

package/dist/types/restricted-names.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"restricted-names.dto.d.ts","sourceRoot":"","sources":["../../src/types/restricted-names.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,2BAA2B;IAC3B,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE,0BAA0B,CAAC;CAClC,GAAG;IACF,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE,6BAA6B,CAAC;CACrC,GAAG;IACF,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}