@gala-chain/launchpad-sdk 8.1.0 → 9.0.0-rc.1

package/dist/types/token.types.d.ts

@@ -1,359 +0,0 @@
-/**
- * # Token Identification in Launchpad SDK
- *
- * The SDK uses **TWO distinct token identifier formats** depending on the operation type.
- * Using the wrong format will result in runtime errors.
- *
- * ## Format 1: Token Name (Launchpad/Bonding Curve Tokens)
- *
- * - **Format**: Simple lowercase string, 3-20 alphanumeric characters
- * - **Examples**: `"anime"`, `"demonkpop"`, `"shoewars"`, `"qatoken"`
- * - **Parameter name**: Usually `tokenName`
- * - **Used for**: Bonding curve operations (before graduation)
- *
- * ```typescript
- * // Correct - Bonding curve buy
- * await sdk.buy({ tokenName: 'anime', amount: '100', type: 'native' });
- *
- * // Correct - Bonding curve sell
- * await sdk.sell({ tokenName: 'anime', amount: '50', type: 'tokens' });
- *
- * // Correct - Check graduation status
- * const pool = await sdk.fetchPools({ tokenName: 'anime' });
- * ```
- *
- * ## Format 2: TokenClassKey (GalaChain/DEX Tokens)
- *
- * - **Format**: Pipe-delimited string with 4 components: `collection|category|type|additionalKey`
- * - **Examples**: `"GALA|Unit|none|none"`, `"GUSDC|Unit|none|eth:0xa0b..."`, `"Token|Unit|ANIME|client:gala-launchpad"`
- * - **Parameter name**: Usually `tokenId`, `fromToken`, `toToken`, or `tokenClassKey`
- * - **Used for**: DEX swaps, LP operations, transfers of standard GalaChain tokens
- *
- * `sdk.dex.*` (the `GSwap` client) accepts either a registered trading symbol (e.g. `"GALA"`)
- * or a full TokenClassKey for `token0`/`token1`/`tokenIn`/`tokenOut` — it resolves a bare
- * symbol against the DEX symbol registry internally, so both forms below work.
- *
- * ```typescript
- * // Correct - DEX swap (requires full tokenClassKey format)
- * const quote = await sdk.dex.quoting.quoteExactInput('GALA|Unit|none|none', 'GUSDC|Unit|none|eth:0xa0b...', '100');
- * const submitted = await sdk.dex.swaps.swap('GALA|Unit|none|none', 'GUSDC|Unit|none|eth:0xa0b...', quote.feeTier, {
- *   exactIn: '100',
- *   amountOutMinimum: quote.amountOut,
- * });
- * const applied = await submitted.confirm();
- *
- * // Correct - Add liquidity to DEX pool
- * await sdk.dex.positions.addLiquidityByPrice({
- *   token0: 'GALA|Unit|none|none',
- *   token1: 'GUSDC|Unit|none|eth:0xa0b...',
- *   fee: 3000,
- *   minPrice: '0.01',
- *   maxPrice: '0.05',
- *   amount: '1000',
- *   amountIsToken0: true,
- * });
- * ```
- *
- * ## Method-to-Format Quick Reference
- *
- * | Method                        | tokenName | tokenClassKey | Notes |
- * |-------------------------------|:---------:|:-------------:|-------|
- * | `buy()`                       | ✅        | ❌            | Bonding curve only, use simple name |
- * | `sell()`                      | ✅        | ❌            | Bonding curve only, use simple name |
- * | `graduateToken()`             | ✅        | ❌            | Triggers DEX migration |
- * | `calculateBuyAmount()`        | ✅        | ❌            | Pre-trade calculation |
- * | `calculateSellAmount()`       | ✅        | ❌            | Pre-trade calculation |
- * | `fetchPools()`                | ✅        | ❌            | Query bonding curve pools |
- * | `fetchTokenPrice()`           | ✅        | ✅            | Smart router auto-detects format |
- * | `dex.swaps.swap()`            | ❌        | ✅            | DEX only, requires full format |
- * | `dex.quoting.quoteExactInput()` | ❌      | ✅            | DEX quotes require full format |
- * | `dex.quoting.quoteExactOutput()` | ❌     | ✅            | DEX quotes require full format |
- * | `dex.positions.addLiquidityByPrice()` | ❌ | ✅            | LP operations use full format |
- * | `dex.positions.removeLiquidity()` | ❌     | ✅            | LP operations use full format |
- * | `transferToken()`             | ✅        | ✅            | Both work (different code paths) |
- * | `transferGala()`              | N/A       | N/A           | GALA amount only, no token param |
- * | `lockTokens()`                | ✅        | ✅            | Both work |
- * | `unlockTokens()`              | ✅        | ✅            | Both work |
- * | `fetchTokenBalance()`         | ✅        | ✅            | Both work |
- * | `isTokenGraduated()`          | ✅        | ❌            | Checks bonding curve status |
- *
- * ## Common Mistakes and How to Fix Them
- *
- * ### Mistake 1: Using a tokenName on a DEX method before the token has graduated
- *
- * ```typescript
- * // ❌ WRONG - 'anime' is the Launchpad tokenName; the DEX symbol registry won't
- * // resolve it until the token graduates and registers its GalaChainDex symbol.
- * await sdk.dex.swaps.swap('anime', 'GALA', 3000, { exactIn: '100', amountOutMinimum: '0.05' });
- *
- * // ✅ CORRECT - a registered trading symbol or full tokenClassKey both work
- * await sdk.dex.swaps.swap('GALA', 'GUSDC', 3000, { exactIn: '100', amountOutMinimum: '0.05' });
- * await sdk.dex.swaps.swap('GALA|Unit|none|none', 'GUSDC|Unit|none|eth:0xa0b...', 3000, { exactIn: '100', amountOutMinimum: '0.05' });
- * ```
- *
- * ### Mistake 2: Using tokenClassKey for bonding curve operations
- *
- * ```typescript
- * // ❌ WRONG - Bonding curve doesn't understand tokenClassKey
- * await sdk.buy({ tokenName: 'ANIME|Unit|none|client:gala-launchpad', amount: '100' });
- *
- * // ✅ CORRECT - Use simple tokenName
- * await sdk.buy({ tokenName: 'anime', amount: '100', type: 'native' });
- * ```
- *
- * ### Mistake 3: Not checking graduation status
- *
- * ```typescript
- * // Check if token has graduated before choosing operation
- * const pool = await sdk.fetchPools({ tokenName: 'anime' });
- * const isGraduated = pool.items[0]?.isGraduated ?? false;
- *
- * if (isGraduated) {
- *   // Token is on DEX - use the tokenClassKey (or its registered symbol)
- *   const tokenClassKey = pool.items[0]?.tokenClassKey;
- *   const submitted = await sdk.dex.swaps.swap(tokenClassKey, 'GALA|Unit|none|none', feeTier, {
- *     exactIn: '100',
- *     amountOutMinimum: output,
- *   });
- *   await submitted.confirm();
- * } else {
- *   // Token is on bonding curve - use tokenName
- *   await sdk.sell({ tokenName: 'anime', amount: '100', type: 'tokens' });
- * }
- * ```
- *
- * ## Token Lifecycle: Bonding Curve → Graduation → DEX
- *
- * 1. **Pre-Graduation (Bonding Curve)**:
- *    - Token trades on bonding curve
- *    - Use `tokenName` for all operations: `buy()`, `sell()`, `calculateBuyAmount()`, etc.
- *    - DEX methods will fail
- *
- * 2. **Graduation Event**:
- *    - Call `graduateToken({ tokenName: 'anime' })` to migrate liquidity to DEX
- *    - One-time irreversible operation
- *
- * 3. **Post-Graduation (DEX)**:
- *    - Token now trades on GalaSwap DEX
- *    - Pool has `tokenClassKey` field with full format
- *    - DEX methods become available: `dex.swaps.swap()`, `dex.quoting.quoteExact*()`, LP methods
- *    - Bonding curve methods (`buy()`, `sell()`) route internally to DEX
- *
- * ## How to Get TokenClassKey for a Token
- *
- * **⚠️ IMPORTANT: You cannot construct a tokenClassKey from a tokenName!**
- *
- * The `type` component in a tokenClassKey is the token's **symbol** (set at creation time),
- * which may differ from the tokenName. For example, a token with `tokenName: "anime"` might
- * have symbol `"ANI"`, `"ANIME"`, or something else entirely.
- *
- * **Always query for the tokenClassKey - never try to construct it manually.**
- *
- * ```typescript
- * // Method 1: From pool data (post-graduation) - RECOMMENDED
- * const pool = await sdk.fetchPools({ tokenName: 'anime' });
- * const tokenClassKey = pool.items[0]?.tokenClassKey;
- * // → Returns the actual tokenClassKey (symbol may differ from tokenName!)
- *
- * // Method 2: Resolve from token name
- * const resolved = await sdk.resolveTokenClassKey('anime');
- * // → Queries backend for the correct tokenClassKey
- *
- * // Method 3: Known standard tokens (these are fixed/well-known)
- * const GALA = 'GALA|Unit|none|none';
- * const GUSDC = 'GUSDC|Unit|none|eth:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48';
- * ```
- *
- * ## TokenClassKey Components Explained
- *
- * Format: `collection|category|type|additionalKey`
- *
- * | Component      | Description                        | Examples |
- * |----------------|------------------------------------|----------|
- * | `collection`   | Token collection/contract          | `GALA`, `GUSDC`, `Token` |
- * | `category`     | Token category                     | `Unit` (fungible), `NFT` |
- * | `type`         | Token **symbol** (set at creation) | `none`, token symbol |
- * | `additionalKey`| Chain-specific or client identifier| `none`, `eth:0x...`, `client:gala-launchpad` |
- *
- * **Note:** For Launchpad tokens, the `type` component is the token's **symbol**, NOT the
- * tokenName. The symbol is chosen by the creator and may differ from the tokenName.
- *
- * ### Common TokenClassKey Patterns
- *
- * ```typescript
- * // Native GALA token
- * 'GALA|Unit|none|none'
- *
- * // Bridged stablecoin (Ethereum USDC)
- * 'GUSDC|Unit|none|eth:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48'
- *
- * // Launchpad graduated token (symbol may differ from tokenName!)
- * // tokenName: 'anime' → symbol could be 'ANI', 'ANIME', etc.
- * 'Token|Unit|{SYMBOL}|client:gala-launchpad'
- *
- * // Gaming item (NFT)
- * 'SpiderTanks|NFT|Tank|season1'
- * ```
- *
- * @packageDocumentation
- * @module TokenIdentification
- * @category Core Concepts
- * @since 5.0.0
- */
-/**
- * Simple token name for Launchpad bonding curve operations.
- *
- * - 3-20 lowercase alphanumeric characters
- * - Used for: `buy()`, `sell()`, `graduateToken()`, `fetchPools()`
- * - NOT valid for DEX operations
- *
- * @example
- * ```typescript
- * const tokenName: TokenName = 'anime';
- * await sdk.buy({ tokenName, amount: '100', type: 'native' });
- * ```
- */
-export type TokenName = string;
-/**
- * Full pipe-delimited token identifier for GalaChain/DEX operations.
- *
- * Format: `collection|category|type|additionalKey`
- *
- * - Required for: `dex.swaps.swap()`, `dex.quoting.quoteExact*()`, LP operations (a registered
- *   trading symbol like `'GALA'` also works for these — see `sdk.dex.*` above)
- * - Also works for: `transferToken()`, `lockTokens()`, `fetchTokenBalance()`
- *
- * @example
- * ```typescript
- * const gala: TokenClassKeyString = 'GALA|Unit|none|none';
- * const gusdc: TokenClassKeyString = 'GUSDC|Unit|none|eth:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48';
- *
- * const submitted = await sdk.dex.swaps.swap(gala, gusdc, feeTier, {
- *   exactIn: '100',
- *   amountOutMinimum: estimatedOutput,
- * });
- * await submitted.confirm();
- * ```
- */
-export type TokenClassKeyString = `${string}|${string}|${string}|${string}`;
-/**
- * Structured TokenClassKey object with named components.
- *
- * This interface represents the parsed form of a TokenClassKeyString.
- * Most SDK methods accept either the string or object form.
- *
- * @example
- * ```typescript
- * const galaKey: TokenClassKeyObject = {
- *   collection: 'GALA',
- *   category: 'Unit',
- *   type: 'none',
- *   additionalKey: 'none'
- * };
- * ```
- */
-export interface TokenClassKeyObject {
-    /** Token collection/contract name (e.g., "GALA", "GUSDC", "Token") */
-    collection: string;
-    /** Token category (e.g., "Unit" for fungible, "NFT" for non-fungible) */
-    category: string;
-    /** Token type within the collection (e.g., "none", "ANIME", item type) */
-    type: string;
-    /** Additional identifier (e.g., "none", "eth:0x...", "client:gala-launchpad") */
-    additionalKey: string;
-}
-/**
- * Token format that works for methods accepting both formats.
- *
- * Some SDK methods like `transferToken()`, `lockTokens()`, and `fetchTokenBalance()`
- * accept either format and will route appropriately.
- */
-export type FlexibleTokenId = TokenName;
-/**
- * Utility type guard to check if a string is a valid TokenClassKey format.
- *
- * @param value - String to check
- * @returns true if the string contains 3 pipe delimiters (valid TokenClassKey format)
- *
- * @example
- * ```typescript
- * if (isTokenClassKey(tokenId)) {
- *   // Safe to use with DEX methods
- *   const submitted = await sdk.dex.swaps.swap(tokenId, otherToken, fee, {
- *     exactIn: amount,
- *     amountOutMinimum: output,
- *   });
- *   await submitted.confirm();
- * } else {
- *   // Treat as tokenName for bonding curve
- *   await sdk.buy({ tokenName: tokenId, amount, type: 'native' });
- * }
- * ```
- */
-export declare function isTokenClassKey(value: string): value is TokenClassKeyString;
-/**
- * Utility type guard to check if a string is a simple token name (not TokenClassKey).
- *
- * @param value - String to check
- * @returns true if the string does not contain pipe delimiters
- *
- * @example
- * ```typescript
- * if (isTokenName(userInput)) {
- *   // Simple token name - use for bonding curve
- *   await sdk.fetchPools({ tokenName: userInput });
- * }
- * ```
- */
-export declare function isTokenName(value: string): value is TokenName;
-/**
- * Well-known token identifiers for common tokens.
- *
- * These constants prevent typos and provide type safety for frequently used tokens.
- *
- * @example
- * ```typescript
- * import { WELL_KNOWN_TOKENS } from '@gala-chain/launchpad-sdk';
- *
- * const submitted = await sdk.dex.swaps.swap(
- *   WELL_KNOWN_TOKENS.GALA,
- *   WELL_KNOWN_TOKENS.GUSDC,
- *   3000,
- *   { exactIn: '1000', amountOutMinimum: estimatedOutput },
- * );
- * await submitted.confirm();
- * ```
- */
-export declare const WELL_KNOWN_TOKENS: {
-    /** Native GALA token */
-    readonly GALA: TokenClassKeyString;
-    /** Bridged USDC (from Ethereum) */
-    readonly GUSDC: TokenClassKeyString;
-    /** Wrapped ETH */
-    readonly WETH: TokenClassKeyString;
-    /** Bridged SOL (from Solana) */
-    readonly GSOL: TokenClassKeyString;
-};
-/**
- * Token format decision helper.
- *
- * Returns guidance on which token format to use based on the operation type.
- *
- * @param operation - The SDK operation you want to perform
- * @returns Object with format recommendation and examples
- *
- * @example
- * ```typescript
- * const guide = getTokenFormatGuide('buy');
- * // → { format: 'tokenName', example: 'anime', notes: 'Bonding curve operations use simple names' }
- *
- * const dexGuide = getTokenFormatGuide('dex.swaps.swap');
- * // → { format: 'tokenClassKey', example: 'GALA|Unit|none|none', notes: 'DEX operations require full format' }
- * ```
- */
-export declare function getTokenFormatGuide(operation: string): {
-    format: 'tokenName' | 'tokenClassKey' | 'both';
-    example: string;
-    notes: string;
-};
-//# sourceMappingURL=token.types.d.ts.map

package/dist/types/token.types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"token.types.d.ts","sourceRoot":"","sources":["../../src/types/token.types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyMG;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,mBAAmB,GAAG,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;AAE5E;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,mBAAmB;IAClC,sEAAsE;IACtE,UAAU,EAAE,MAAM,CAAC;IAEnB,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAC;IAEjB,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IAEb,iFAAiF;IACjF,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,mBAAmB,CAI3E;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,SAAS,CAE7D;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,iBAAiB;IAC5B,wBAAwB;mBACO,mBAAmB;IAElD,mCAAmC;oBACwC,mBAAmB;IAE9F,kBAAkB;mBACuD,mBAAmB;IAE5F,gCAAgC;mBAC0C,mBAAmB;CACrF,CAAC;AAEX;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG;IACtD,MAAM,EAAE,WAAW,GAAG,eAAe,GAAG,MAAM,CAAC;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,CAkCA"}

package/dist/types/wrappable-token.dto.d.ts

@@ -1,305 +0,0 @@
-/**
- * Wrappable Token Types
- *
- * Type definitions for dynamically fetched wrappable tokens from DEX API.
- * Wrappable tokens are token pairs where one can be wrapped/unwrapped into
- * the other (e.g., MUSIC ↔ GMUSIC).
- *
- * @category Types
- * @since 4.0.18
- */
-import type { BaseCacheStats } from '../services/AbstractCacheService.js';
-import type { TokenId } from './common.js';
-/**
- * Current USD price information from API response
- */
-export interface WrappableTokenPrices {
-    /** Current USD price */
-    usd?: number;
-    /** 24-hour price change percentage */
-    usd24hChange?: number;
-    /** 24-hour trading volume in USD */
-    usd24hVol?: number;
-    /** Market cap in USD */
-    usdMarketCap?: number;
-    /** Timestamp of last price update */
-    lastUpdatedAt?: string;
-}
-/**
- * Raw wrappable token response from DEX API /v1/tokens?wrappable=true
- *
- * This is the structure returned directly from the API.
- */
-export interface WrappableTokenApiResponse {
-    /** Token symbol on GalaChain (e.g., "MUSIC", "GMUSIC") */
-    symbol: string;
-    /** Token display name */
-    name: string;
-    /** Token decimals */
-    decimals: number;
-    /** Token description */
-    description?: string;
-    /** Token image URL */
-    image?: string;
-    /** Pipe-delimited token class key (e.g., "$MUSIC|Unit|none|none") */
-    stringifiedTokenClassKey: string;
-    /** Token collection */
-    collection: string;
-    /** Token category */
-    category: string;
-    /** Token type */
-    type: string;
-    /** Additional key */
-    additionalKey: string;
-    /** Network (always "GC" for GalaChain) */
-    network: string;
-    /** Whether the token is verified */
-    verified: boolean;
-    /** Whether the token is swappable on DEX */
-    swappable: boolean;
-    /** Token channel (e.g., "music", "asset") */
-    channel?: string;
-    /** Whether the token is trending */
-    trending?: boolean;
-    /** Bridge destination chain ID (if bridgeable) */
-    bridgeDestinationChainId?: number;
-    /** Whether bridging is disabled */
-    disableBridge?: boolean;
-    /** Price symbol for external price sources */
-    priceSymbol?: string;
-    /** Whether price is known to external sources */
-    priceIsKnownToExternalPriceSource?: boolean;
-    /** Counterpart token's stringified TokenClassKey (e.g., "$GMUSIC|Unit|none|none") */
-    wrap: string;
-    /** Current USD prices (optional) */
-    currentPrices?: WrappableTokenPrices;
-    /** User's balance (only when address param provided) */
-    balance?: string;
-}
-/**
- * Paginated response from /v1/tokens?wrappable=true API
- */
-export interface WrappableTokensApiResponse {
-    /** Array of wrappable tokens */
-    tokens: WrappableTokenApiResponse[];
-}
-/**
- * Processed wrappable token for SDK use
- *
- * This is the normalized structure used internally by the SDK.
- */
-export interface WrappableToken {
-    /** Token symbol on GalaChain (e.g., "MUSIC", "GMUSIC") */
-    symbol: string;
-    /** Token display name */
-    name: string;
-    /** Token decimals */
-    decimals: number;
-    /** GalaChain token descriptor */
-    galaChainDescriptor: {
-        collection: string;
-        category: string;
-        type: string;
-        additionalKey: string;
-    };
-    /** Pipe-delimited token class key */
-    stringifiedTokenClassKey: string;
-    /** Counterpart token's stringified TokenClassKey */
-    wrapCounterpart: string;
-    /** Whether the token is swappable on DEX */
-    swappable: boolean;
-    /** Whether the token is verified */
-    verified: boolean;
-    /** Token channel (e.g., "music", "asset") */
-    channel?: string;
-    /** Whether the token is trending */
-    trending?: boolean;
-    /** Token image URL */
-    image?: string;
-    /** Token description */
-    description?: string;
-    /** Current USD prices */
-    currentPrices?: WrappableTokenPrices;
-}
-/**
- * Options for fetching wrappable tokens (metadata only, no balance)
- */
-export interface FetchWrappableTokensOptions {
-    /** Pagination offset (default: 0) */
-    offset?: number;
-    /** Results per page (max: 1000, default: 1000) */
-    limit?: number;
-}
-/**
- * Result of fetching wrappable tokens (metadata only, no balance)
- */
-export interface FetchWrappableTokensResult {
-    /** Array of wrappable tokens */
-    tokens: WrappableToken[];
-    /** Timestamp when data was fetched */
-    fetchedAt: number;
-    /** Number of tokens returned */
-    tokenCount: number;
-}
-/**
- * Options for getting a wrappable token by tokenId
- */
-export interface GetWrappableTokenOptions {
-    /**
-     * Token identifier in flexible format.
-     *
-     * Accepts:
-     * - Pipe-delimited string: "$MUSIC|Unit|none|none"
-     * - TokenClassKey object: { collection: '$MUSIC', category: 'Unit', type: 'none', additionalKey: 'none' }
-     *
-     * @example "$MUSIC|Unit|none|none"
-     * @example { collection: '$MUSIC', category: 'Unit', type: 'none', additionalKey: 'none' }
-     */
-    tokenId: TokenId;
-}
-/**
- * Result of checking if a token is wrappable
- */
-export interface IsTokenWrappableResult {
-    /** Whether the token is wrappable */
-    isWrappable: boolean;
-    /** The queried token's stringified TokenClassKey */
-    tokenId: string;
-    /** Counterpart token's stringified TokenClassKey (if wrappable) */
-    wrapCounterpart?: string;
-}
-/**
- * Cache statistics for wrappable tokens
- *
- * Note: Uses `totalItems` from BaseCacheStats for token count.
- * The `tokenCount` alias is provided for convenience.
- */
-export interface WrappableTokenCacheStats extends BaseCacheStats {
-    /** Number of tokens in cache (alias for totalItems) */
-    tokenCount: number;
-    /** Whether cache is populated */
-    isPopulated: boolean;
-    /** Timestamp when cache was last updated */
-    lastFetchedAt: number | null;
-}
-/**
- * Options for wrapping a token (e.g., MUSIC → GMUSIC)
- *
- * Wrapping transfers a token from its native channel to the asset channel,
- * converting it to its wrapped counterpart. This is required for tokens
- * like MUSIC to be traded on the DEX.
- *
- * @example
- * ```typescript
- * const result = await sdk.wrapToken({
- *   tokenId: 'MUSIC',
- *   amount: '100.5',
- * });
- * ```
- */
-export interface WrapTokenOptions {
-    /**
-     * Token to wrap (source token on native channel).
-     *
-     * Accepts:
-     * - Symbol: "MUSIC"
-     * - Pipe-delimited: "$MUSIC|Unit|none|none"
-     * - TokenClassKey object: { collection: '$MUSIC', ... }
-     */
-    tokenId: TokenId;
-    /** Amount to wrap (decimal string, e.g., "100.5") */
-    amount: string;
-    /** Optional recipient address (defaults to sender) */
-    recipient?: string;
-    /** Optional memo for the transaction */
-    memo?: string;
-}
-/**
- * Options for unwrapping a token (e.g., GMUSIC → MUSIC)
- *
- * Unwrapping transfers a token from the asset channel back to its native
- * channel, converting it from the wrapped version to the original.
- *
- * @example
- * ```typescript
- * const result = await sdk.unwrapToken({
- *   tokenId: 'GMUSIC',
- *   amount: '50',
- * });
- * ```
- */
-export interface UnwrapTokenOptions {
-    /**
-     * Token to unwrap (wrapped token on asset channel).
-     *
-     * Accepts:
-     * - Symbol: "GMUSIC"
-     * - Pipe-delimited: "$GMUSIC|Unit|none|none"
-     * - TokenClassKey object: { collection: '$GMUSIC', ... }
-     */
-    tokenId: TokenId;
-    /** Amount to unwrap (decimal string, e.g., "50") */
-    amount: string;
-    /** Optional recipient address (defaults to sender) */
-    recipient?: string;
-    /** Optional memo for the transaction */
-    memo?: string;
-}
-/**
- * Result of a wrap or unwrap operation
- */
-export interface WrapUnwrapResult {
-    /** Whether the operation succeeded */
-    success: boolean;
-    /** Transaction hash/ID for tracking */
-    transactionId?: string;
-    /** Source token symbol (e.g., "MUSIC" for wrap, "GMUSIC" for unwrap) */
-    fromToken: string;
-    /** Destination token symbol (e.g., "GMUSIC" for wrap, "MUSIC" for unwrap) */
-    toToken: string;
-    /** Amount transferred (decimal string) */
-    amount: string;
-    /** Source channel name (e.g., "music", "asset") */
-    fromChannel: string;
-    /** Destination channel name (e.g., "asset", "music") */
-    toChannel: string;
-    /** Fee paid for the operation (if any) */
-    fee?: string;
-    /** Timestamp when the operation completed (epoch ms) */
-    completedAt?: number;
-    /** Error message if operation failed */
-    error?: string;
-}
-/**
- * Fee estimation for wrap/unwrap operations
- *
- * Wrap and unwrap operations may have different fee authorization types:
- * - Wrap (→ asset): Uses `cross_channel_authorization` on source channel
- * - Unwrap (→ native): Uses `automatic` authorization on asset channel
- */
-export interface WrapUnwrapFeeEstimate {
-    /** Estimated fee amount (decimal string) */
-    fee: string;
-    /** Fee token symbol (usually "GALA") */
-    feeToken: string;
-    /** Fee authorization type used by the backend */
-    authorizationType: 'cross_channel_authorization' | 'automatic';
-    /** Channel where the fee is authorized/charged */
-    feeChannel: string;
-}
-/**
- * Status of a wrap/unwrap operation
- */
-export type WrapUnwrapStatus = 'pending' | 'processing' | 'completed' | 'failed';
-/**
- * Extended result with status polling information
- */
-export interface WrapUnwrapStatusResult extends WrapUnwrapResult {
-    /** Current status of the operation */
-    status: WrapUnwrapStatus;
-    /** Number of confirmations (if applicable) */
-    confirmations?: number;
-    /** Estimated time remaining in ms (if available) */
-    estimatedTimeRemainingMs?: number;
-}
-//# sourceMappingURL=wrappable-token.dto.d.ts.map

package/dist/types/wrappable-token.dto.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"wrappable-token.dto.d.ts","sourceRoot":"","sources":["../../src/types/wrappable-token.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,wBAAwB;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wBAAwB;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,qCAAqC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,0DAA0D;IAC1D,MAAM,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,wBAAwB,EAAE,MAAM,CAAC;IACjC,uBAAuB;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,4CAA4C;IAC5C,SAAS,EAAE,OAAO,CAAC;IACnB,6CAA6C;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kDAAkD;IAClD,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,mCAAmC;IACnC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iDAAiD;IACjD,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAC5C,qFAAqF;IACrF,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,gCAAgC;IAChC,MAAM,EAAE,yBAAyB,EAAE,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,0DAA0D;IAC1D,MAAM,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,iCAAiC;IACjC,mBAAmB,EAAE;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,qCAAqC;IACrC,wBAAwB,EAAE,MAAM,CAAC;IACjC,oDAAoD;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,4CAA4C;IAC5C,SAAS,EAAE,OAAO,CAAC;IACnB,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,6CAA6C;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sBAAsB;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yBAAyB;IACzB,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,qCAAqC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,gCAAgC;IAChC,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;;;;;OASG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,qCAAqC;IACrC,WAAW,EAAE,OAAO,CAAC;IACrB,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,mEAAmE;IACnE,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,cAAc;IAC9D,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,iCAAiC;IACjC,WAAW,EAAE,OAAO,CAAC;IACrB,4CAA4C;IAC5C,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAMD;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;OAOG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;OAOG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sCAAsC;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB,uCAAuC;IACvC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAC;IAClB,6EAA6E;IAC7E,OAAO,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,mDAAmD;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,4CAA4C;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,iDAAiD;IACjD,iBAAiB,EAAE,6BAA6B,GAAG,WAAW,CAAC;IAC/D,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,SAAS,GACT,YAAY,GACZ,WAAW,GACX,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D,sCAAsC;IACtC,MAAM,EAAE,gBAAgB,CAAC;IACzB,8CAA8C;IAC9C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oDAAoD;IACpD,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC"}