@gala-chain/launchpad-sdk 5.0.4-beta.1 → 5.0.4-beta.15

package/CHANGELOG.md

@@ -1,5 +1,87 @@
 # Changelog
 
+## 6.0.0
+
+### BREAKING CHANGES
+
+- **`getStreamInfo()` method REMOVED** - Consolidated into `fetchToken()`
+  - **Removed**: v6.0.0
+  - **Status**: No longer available (previously worked in v5.x)
+  - **Replacement**: `fetchToken(tokenName)` - Returns PoolData with streaming fields
+  - **Why**: Eliminated redundant API method. Streaming fields now consolidated in PoolData response. Single `fetchToken()` call provides all token data (pool metrics + streaming info) instead of separate calls.
+  - **Impact**: MUST update code before upgrading to v6.0.0
+
+  **Migration Path:**
+  ```typescript
+  // ❌ REMOVED in v6.0.0 - NO LONGER WORKS
+  const info = await sdk.getStreamInfo('mytoken');
+  console.log(`Live: ${info.isLive}, Viewers: ${info.viewerCount}`);
+
+  // ✅ NEW (v6.0.0+) - Use fetchToken instead
+  const pool = await sdk.fetchToken('mytoken');
+  console.log(`Status: ${pool.muxStreamStatus}`); // 'IDLE' | 'ACTIVE' | 'DISABLED'
+  console.log(`Viewers: ${pool.currentViewerCount}`);
+  console.log(`Playback: ${pool.playbackId}`);
+  console.log(`Aspect Ratio: ${pool.aspectRatio}`);
+  ```
+
+  **Streaming Fields Now in PoolData**:
+  - `playbackId`: string | null (viewer playback ID)
+  - `aspectRatio`: string (e.g., "16:9", "9:16")
+  - `muxStreamStatus`: 'IDLE' | 'ACTIVE' | 'DISABLED'
+  - `nextLiveStreamAt`: string | null (ISO 8601 scheduled time)
+  - `language`: string (ISO 639-1 code, e.g., "en", "es")
+  - `streamEnabled`: boolean
+  - `currentViewerCount`: number (live viewers, v5.7.0+)
+  - `peakViewerCount`: number (peak in session, v5.7.0+)
+  - `streamStartedAt`: string | null (when stream became active, v5.7.0+)
+  - `lastStreamedAt`: string | null (last streaming timestamp, v5.7.0+)
+  - `recordingsCount`: number (total recordings, v5.8.0+)
+  - `totalSecondsStreamed`: number (cumulative duration, v5.8.0+)
+
+### New Features
+
+- **`fetchToken(tokenName)` method** - Unified token data retrieval with streaming
+  - Returns complete PoolData object with all token and streaming information
+  - Replaces separate getStreamInfo() call
+  - Single API request for all token data
+  - All streaming fields consolidated in response
+  - Streaming data always available (no separate call needed)
+  - Example: `const pool = await sdk.fetchToken('mytoken')`
+
+- **`validateToken(options)` method** - Token name/symbol validation for creation
+  - Real-time form validation support
+  - Checks name and/or symbol availability
+  - Returns blocklist status and validation errors
+  - Use cases: token creation workflows, form validation, pre-launch checks
+  - Example: `const result = await sdk.validateToken({ tokenName: 'mytoken', symbol: 'MYT' })`
+
+### Benefits
+
+- **Reduced API calls**: One `fetchToken()` call provides all data (previously required separate pool + streaming calls)
+- **Cleaner architecture**: No redundant getStreamInfo() method
+- **Better DX**: All token data in single PoolData object with type safety
+- **Form validation**: New `validateToken()` enables real-time validation for token creation
+- **Unified response**: Streaming fields integrated into standard PoolData response structure
+
+### Migration Checklist
+
+- [ ] Replace all `getStreamInfo()` calls with `fetchToken()`
+- [ ] Update streaming field access patterns (muxStreamStatus, playbackId, etc.)
+- [ ] Test pool data access for all streaming fields
+- [ ] Add `validateToken()` for token creation form validation if needed
+- [ ] Run full test suite against v6.0.0
+- [ ] Update any documentation/guides referencing old methods
+
+### Expected Impact
+
+- **Bundle size**: Minimal change (removed getStreamInfo method, added fetchToken + validateToken)
+- **API calls**: Reduced (consolidated streaming into pool fetch)
+- **Code maintenance**: Improved (unified response structure)
+- **Developer experience**: Enhanced (single method for all token data, real-time validation)
+
+---
+
 ## 4.0.0
 
 ### BREAKING CHANGES

package/README.md

@@ -77,6 +77,7 @@ console.log(pools.meta.page < pools.meta.totalPages); // Has more pages
 - **External Wallet Balances**: Query Ethereum and Solana wallet balances (single-token or full portfolio)
 - **Live Streaming**: Start/stop streams, manage recordings and simulcast targets for token pools (v5.1.0+)
 - **Stream Chat**: Real-time chat messaging via REST and WebSocket with admin controls (v5.1.0+)
+- **Global Feed**: Unified real-time event stream for token updates and site configuration changes (v7.0.0+)
 - **Overseer System**: Global platform oversight with CCTV dashboard, invite management, and platform summary (v5.9.0+)
 - **Moderator System**: Token-scoped moderation with magic link invites (v5.7.0+)
 - **Content Flags**: Report and manage flagged content with two-tier review system (v5.8.0+)
@@ -560,12 +561,11 @@ const pools = await sdk.fetchDexPools({
   search: 'GALA',           // Filter by token symbol
   sortBy: 'tvl',            // Sort options: tvl, volume30d, volume1d
   sortOrder: 'desc',        // asc or desc
-  page: 1,                  // Pagination (default: 1)
-  limit: 10                 // Results per page (default: 10, max: 20)
+  pageSize: 20              // Results per page (default: 20, max: 50)
 });
 
-console.log(`Found ${pools.meta.total} total pools`);
-console.log(`Showing ${pools.items.length} pools on page ${pools.meta.page}`);
+console.log(`Found ${pools.meta?.total || 'many'} pools`);
+console.log(`Showing ${pools.items.length} pools with cursor-based pagination`);
 
 // Fetch ALL pools with automatic pagination
 const allPools = await sdk.fetchAllDexPools({
@@ -623,7 +623,7 @@ console.log(`APR: ${topPool.apr1d.toFixed(2)}%`);
 const galaPools = await sdk.fetchDexPools({
   search: 'GALA',
   sortBy: 'tvl',
-  limit: 20
+  pageSize: 20
 });
 
 galaPools.items.forEach(pool => {
@@ -655,20 +655,35 @@ bestAprPools.forEach(pool => {
 
 ### Pagination
 
-The SDK enforces a **maximum of 20 items per page** (backend limit). Use `fetchAllDexPools()` for complete enumeration:
+The SDK uses cursor-based pagination with configurable page sizes. Use `fetchAllDexPools()` for complete enumeration:
 
 ```typescript
-// Page-by-page discovery (20 max per page)
-const page1 = await sdk.fetchDexPools({ page: 1, limit: 20 });
-console.log(`Page 1: ${page1.items.length} pools`);
-console.log(`Total pages: ${page1.meta.totalPages}`);
-console.log(`Has next: ${page1.meta.page < page1.meta.totalPages}`);
+// Cursor-based discovery (20 max per page)
+let cursor: string | undefined;
+const result = await sdk.fetchDexPools({ pageSize: 20, cursor });
+console.log(`Showing: ${result.items.length} pools`);
+console.log(`Has next: ${result.pageInfo?.hasNextPage}`);
+if (result.pageInfo?.hasNextPage) cursor = result.pageInfo?.nextCursor;
 
 // Automatic pagination - get all at once
 const allAtOnce = await sdk.fetchAllDexPools();
 console.log(`All pools: ${allAtOnce.items.length}`);
 ```
 
+**Cursor-Based Pagination Loop:**
+```typescript
+// Manually iterate through paginated results using cursors
+let cursor: string | undefined;
+const allPools = [];
+while (true) {
+  const result = await sdk.fetchDexPools({ pageSize: 20, cursor });
+  allPools.push(...result.items);
+  if (!result.pageInfo?.hasNextPage) break;
+  cursor = result.pageInfo?.nextCursor;
+}
+console.log(`Retrieved ${allPools.length} total pools`);
+```
+
 ### Development vs Production Environments
 
 The SDK automatically uses the correct DEX backend based on your environment configuration:
@@ -865,9 +880,9 @@ const sdk = createLaunchpadSDK({
 // Clean, direct result access - All methods use options objects
 
 // Pool Management - Direct result properties
-const pools = await sdk.fetchPools({ type: 'recent', limit: 10 });
-console.log(`Found ${pools.total} pools across ${pools.totalPages} pages`);
-console.log(`Current page: ${pools.page}, Has next: ${pools.hasNext}`);
+const pools = await sdk.fetchPools({ type: 'recent', pageSize: 20 });
+console.log(`Found ${pools.meta?.total} pools`);
+console.log(`Has next page: ${pools.pageInfo?.hasNextPage}`);
 
 const badges = await sdk.fetchTokenBadges('dragnrkti');
 console.log(`Volume badges: ${badges.volumeBadges.length}`);
@@ -944,18 +959,18 @@ const sdk = createLaunchpadSDK({
 
 // MODE 1: Single Page (backward compatible)
 // Limit <= 20: Single API call
-const recent = await sdk.fetchPools({ type: 'recent', limit: 20 });
+const recent = await sdk.fetchPools({ type: 'recent', pageSize: 20 });
 console.log(`Fetched ${recent.items.length} pools in one request`);
 
 // MODE 2: Multi-Page Auto-Fetch
 // Limit > 20: Automatic concurrent multi-page fetching
-const large = await sdk.fetchPools({ type: 'popular', limit: 100 });
+const large = await sdk.fetchPools({ type: 'popular', pageSize: 100 });
 console.log(`Fetched ${large.items.length} pools across multiple pages`);
-// Internally fetches 5 pages concurrently: 20+20+20+20+20 = 100 pools
+// Internally uses cursor-based pagination to efficiently fetch all items
 
 // MODE 3: Infinite Fetch
 // Limit = 0: Fetches ALL available pools
-const all = await sdk.fetchPools({ limit: 0 });
+const all = await sdk.fetchAllPools();
 console.log(`Fetched all ${all.items.length} pools from the platform`);
 
 // Convenience method for "fetch all" pattern
@@ -1040,7 +1055,7 @@ const dragons = await sdk.fetchAllPools({ search: 'dragon' });
 // Fetch specific token across all results
 const specific = await sdk.fetchAllPools({ tokenName: 'anime' });
 
-// Equivalent to fetchPools({ limit: 0 })
+// Automatic pagination handles all pages internally
 const all = await sdk.fetchAllPools();
 ```
 
@@ -1107,10 +1122,10 @@ const sdk = createLaunchpadSDK({
 // 2. Check available pools - direct access to results
 const pools = await sdk.fetchPools({
   type: 'recent',
-  limit: 10
+  pageSize: 20
 });
 
-console.log(`Found ${pools.meta.total} pools across ${pools.meta.totalPages} pages`);
+console.log(`Found ${pools.meta.total} pools`);
 pools.items.forEach(pool => {
   console.log(`Pool: ${pool.tokenName} created at ${pool.createdAt}`);
 });
@@ -1544,12 +1559,12 @@ const invalidKey3 = '0x123'; // Too short
 ```typescript
 // Pool Management
 fetchPools(options?): Promise<PoolsResult>
-// Returns: { pools, page, limit, total, totalPages, hasNext, hasPrevious }
-// Supports auto-pagination: limit <= 20 (single page), limit > 20 (multi-page), limit = 0 (all pools)
+// Returns: { items, meta: { total }, pageInfo: { hasNextPage, nextCursor } }
+// Supports cursor-based pagination with configurable pageSize
 
 fetchAllPools(options?): Promise<PoolsResult>
-// Returns: { pools, page, limit, total, totalPages, hasNext, hasPrevious }
-// Convenience method that fetches ALL pools (equivalent to fetchPools({ limit: 0 }))
+// Returns: { items, meta: { total }, pageInfo: { hasNextPage } }
+// Convenience method that fetches ALL pools using cursor-based pagination
 
 fetchTokenDistribution(tokenName): Promise<TokenDistributionResult>
 // Returns: { holders, totalSupply, totalHolders, lastUpdated }
@@ -1569,7 +1584,7 @@ fetchVolumeData(options): Promise<GraphDataResult>
 
 // Trade & User Data
 fetchTrades(options): Promise<TradesResult>
-// Returns: { trades, page, limit, total, totalPages, hasNext, hasPrevious }
+// Returns: { items, meta: { total }, pageInfo: { hasNextPage, nextCursor } }
 
 fetchGalaBalance(address?): Promise<GalaBalanceInfo>
 // Returns: { userAddress, balance, decimals, lastUpdated }
@@ -1578,7 +1593,7 @@ fetchTokenBalance(options): Promise<TokenBalanceInfo>
 // Returns: { quantity, holdingPriceUsd, holdingPriceGala, isFinalized, ... }
 
 fetchComments(options): Promise<CommentsResult>
-// Returns: { comments, page, limit, total, totalPages, hasNext, hasPrevious }
+// Returns: { items, meta: { total }, pageInfo: { hasNextPage, nextCursor } }
 
 fetchProfile(address?): Promise<UserProfile>
 // Returns: { fullName, profileImage, address, ... }
@@ -1630,7 +1645,7 @@ fetchPriceHistory(options): Promise<PriceHistoryResult>
 // Token identification (provide EXACTLY ONE):
 //   - tokenName: Simple token name (e.g., "demonkpop") - auto-resolves to tokenId
 //   - tokenId: Full token class key (e.g., "Token|Unit|DKP|eth:...")
-// Returns: { snapshots, page, limit, total, totalPages, hasNext, hasPrevious }
+// Returns: { items, meta: { total }, pageInfo: { hasNextPage, nextCursor } }
 // Fetches paginated historical price snapshots from DEX Backend API
 
 fetchAllPriceHistory(options): Promise<PriceHistoryResult>
@@ -1897,7 +1912,7 @@ let cacheInfo = sdk.getCacheInfo();
 console.log('Cached tokens:', cacheInfo.totalTokens); // 0
 
 // Fetch pools - automatically warms cache with RBC fees and vault addresses
-await sdk.fetchPools({ type: 'recent', limit: 20 });
+await sdk.fetchPools({ type: 'recent', pageSize: 20 });
 
 // After fetching - cache is warmed with 20 tokens
 cacheInfo = sdk.getCacheInfo();
@@ -1945,9 +1960,9 @@ console.log('Instant result:', calc.amount); // <1ms, used cached RBC fees
 
 ```typescript
 // Cache automatically manages size
-await sdk.fetchPools({ limit: 100 }); // Warms cache with 100 tokens
-await sdk.fetchPools({ limit: 100 }); // Warms with 100 more tokens
-await sdk.fetchPools({ limit: 100 }); // ... continues
+await sdk.fetchPools({ pageSize: 100 }); // Fetches 100 tokens
+await sdk.fetchPools({ pageSize: 100 }); // Fetches 100 more tokens
+await sdk.fetchPools({ pageSize: 100 }); // ... continues
 
 // When 10,000 limit reached, oldest tokens are evicted automatically
 const stats = sdk.getCacheInfo();
@@ -2013,7 +2028,7 @@ const sdk = createLaunchpadSDK({
 
 // 1. Warm cache by fetching pools
 console.log('Warming cache...');
-await sdk.fetchPools({ type: 'popular', limit: 50 });
+await sdk.fetchPools({ type: 'popular', pageSize: 50 });
 
 // 2. Check cache statistics
 const stats = sdk.getCacheInfo();
@@ -2082,8 +2097,7 @@ const sdk = createLaunchpadSDK({
 // ✅ NEW: Use simple token name (auto-resolves to full token ID)
 const recentHistory = await sdk.fetchPriceHistory({
   tokenName: 'demonkpop', // Simple, intuitive token name
-  page: 1,
-  limit: 20
+  pageSize: 20
 });
 
 console.log(`Latest price: $${recentHistory.snapshots[0].price}`);
@@ -2092,8 +2106,7 @@ console.log(`Total snapshots: ${recentHistory.total}`);
 // ✅ STILL WORKS: Direct token ID (for advanced use cases)
 const historyWithId = await sdk.fetchPriceHistory({
   tokenId: 'Token|Unit|DKP|eth:4A65D29213de2939373ff9eB63AC38730F192C84',
-  page: 1,
-  limit: 20
+  pageSize: 20
 });
 ```
 
@@ -2106,7 +2119,7 @@ const monthlyHistory = await sdk.fetchPriceHistory({
   from: new Date('2025-01-01'),
   to: new Date('2025-02-01'),
   sortOrder: 'ASC', // Chronological order for analysis
-  limit: 50
+  pageSize: 50
 });
 
 const prices = monthlyHistory.snapshots.map(s => parseFloat(s.price));
@@ -2129,7 +2142,7 @@ const recentData = await sdk.fetchPriceHistory({
   tokenName: 'demonkpop',
   from: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000), // Last 7 days
   sortOrder: 'DESC',
-  limit: 20
+  pageSize: 20
 });
 
 const ma7 = recentData.snapshots
@@ -2171,15 +2184,13 @@ try {
 // ❌ BEFORE (v3.19 and earlier) - Had to provide full token class key
 const history = await sdk.fetchPriceHistory({
   tokenId: 'Token|Unit|DKP|eth:4A65D29213de2939373ff9eB63AC38730F192C84',
-  page: 1,
-  limit: 10
+  pageSize: 10
 });
 
 // ✅ AFTER (v3.20+) - Simple token name, auto-resolves internally
 const history = await sdk.fetchPriceHistory({
   tokenName: 'demonkpop',
-  page: 1,
-  limit: 10
+  pageSize: 10
 });
 ```
 
@@ -2456,6 +2467,22 @@ uploadProfileImage(options): Promise<ImageUploadResult>
 // Returns: { imageUrl, success, ... }
 ```
 
+### **Token Data & Validation (v6.0.0+)**
+
+```typescript
+// Fetch complete token data with streaming information consolidated
+fetchToken(tokenName: string): Promise<PoolData>
+// Returns: Complete pool data including streaming fields (playbackId, muxStreamStatus, currentViewerCount, etc.)
+// Example: const pool = await sdk.fetchToken('mytoken');
+
+// Validate token name/symbol for creation or form validation
+validateToken(options: { tokenName?: string, symbol?: string }): Promise<ValidateTokenResponse>
+// Returns: { nameAvailable, symbolAvailable, nameBlocklisted, symbolBlocklisted, errors }
+// Example: const result = await sdk.validateToken({ tokenName: 'mytoken', symbol: 'MYT' });
+```
+
+**Migration Note (v6.0.0)**: `getStreamInfo()` was removed. Use `fetchToken()` instead - streaming fields now consolidated in PoolData response.
+
 ### **Validation & Utilities**
 - `isTokenNameAvailable(tokenName: string): Promise<boolean>`
 - `isTokenSymbolAvailable(symbol: string): Promise<boolean>`
@@ -2700,6 +2727,18 @@ npm run lint
 - [Liquidity Response Structures](./docs/LIQUIDITY_RESPONSES.md) - Detailed reference for all liquidity operation response formats and error handling
 - [GSwap SDK Integration](./docs/GSWAP_INTEGRATION.md) - Deep dive into GSwap patterns, token formats, and advanced trading workflows
 
+### NFT Collection Management
+
+- [NFT Quick Reference](./docs/NFT_QUICK_REFERENCE.md) - Quick lookup for NFT collection, token class, and minting operations with fee schedules
+- [NFT Operations Guide](./docs/NFT_OPERATIONS.md) - Complete guide for claiming collections, creating token classes, minting NFTs, and querying NFT data
+
+### WebSocket & Real-Time Events
+
+- [WebSocket Documentation Hub](./docs/websocket/) - Complete guide to WebSocket connections and real-time events
+- [Global Feed Quick Start](./docs/websocket/QUICKSTART.md) - Get real-time updates in 5 minutes
+- [Global Feed Guide](./docs/websocket/GLOBAL-FEED.md) - Comprehensive guide to unified event streaming
+- [WebSocket Authentication](./docs/websocket/AUTHENTICATION.md) - JWT authentication and security best practices
+
 ### Demo Scripts
 
 The SDK includes 36 comprehensive demo scripts organized into logical categories for easy discovery and learning.
@@ -2926,7 +2965,7 @@ LaunchpadService uses a **facade pattern** internally, delegating to specialized
 LaunchpadService (facade)
 ├── PoolService - Pool queries, distribution, badges, volume data
 │   ├── fetchPools() - Supports auto-pagination (v3.11.0+)
-│   ├── fetchAllPools() - Convenience method for limit: 0
+│   ├── fetchAllPools() - Convenience method for fetching all pools
 │   └── ...other pool operations
 ├── TradeService - Trade history and queries
 ├── CommentService - Comments with vault resolution
@@ -3008,7 +3047,7 @@ For comprehensive AI agent integration, see:
 ✅ **Direct Property Access**: No more `result.data.success` chains
 ✅ **Type Safety**: Full TypeScript IntelliSense for all result properties
 ✅ **Semantic Types**: Dates as Date objects, numbers as numbers
-✅ **Computed Properties**: `hasNext`, `hasPrevious` for convenience
+✅ **Cursor Pagination**: `pageInfo.hasNextPage`, `pageInfo.nextCursor` for cursor-based navigation
 ✅ **Zero Wrapper Overhead**: Clean, direct access to all result data
 ✅ **Options Object Pattern**: All multi-parameter methods use options objects
 
@@ -3018,9 +3057,9 @@ For comprehensive AI agent integration, see:
 // Pool results with pagination
 interface PoolsResult {
   pools: PoolData[];           // Direct pool array
-  page: number;                // Current page
+  cursor?: string;              // Cursor for pagination
   total: number;               // Total items
-  hasNext: boolean;            // Computed convenience
+  pageSize: number;             // Items returned per page
   // ... more properties
 }
 
@@ -3042,6 +3081,85 @@ interface AmountCalculationResult {
 }
 ```
 
+
+## What's New in v7.0.0+
+
+### Unified Messages API
+
+All message types (CHAT and COMMENT) are now accessible through a single unified endpoint:
+
+```typescript
+// List all message types for a token
+const result = await sdk.listMessages({ tokenName: 'anime' });
+
+// Filter by type
+const chatOnly = await sdk.listMessages({
+  tokenName: 'anime',
+  contentType: 'CHAT'
+});
+
+// Create, update, delete messages
+await sdk.createMessage({
+  tokenName: 'anime',
+  contentType: 'CHAT',
+  content: 'Great project!'
+});
+
+// Pin important messages
+await sdk.pinMessage(messageId);
+```
+
+### User Data Access
+
+New methods for accessing user information:
+
+```typescript
+// Fetch user token balances
+const balances = await sdk.fetchUserBalances({
+  address: '0x...',
+  pageSize: 50
+});
+
+// Get comprehensive user report (Overseer only)
+const report = await sdk.fetchUserReport({
+  address: '0x...'
+});
+```
+
+### Token Statistics
+
+Get engagement metrics for tokens:
+
+```typescript
+const stats = await sdk.fetchTokenStats('anime');
+console.log(`Messages: ${stats.messageCount}`);
+console.log(`Peak viewers: ${stats.peakViewerCount}`);
+```
+
+### Simplified Restricted Names Management
+
+Manage platform restricted words with a simplified API:
+
+```typescript
+// Get current list
+const result = await sdk.getRestrictedNames();
+const names = result.data.content.split('\n');
+
+// Update list
+await sdk.updateRestrictedNames('badword1\nbadword2\nbadword3');
+```
+
+## Documentation
+
+Comprehensive documentation for all SDK features:
+
+- **[SDK API Updates](../docs/SDK_API_UPDATES.md)** - Complete guide to new v7.0.0+ methods
+- **[Usage Guide](../docs/USAGE_GUIDE.md)** - Step-by-step examples for all features
+- **[API Reference](../docs/API-REFERENCE.md)** - Complete method reference with signatures
+- **[DTO Reference](../docs/DTO_REFERENCE.md)** - All data type definitions
+- **[Migration Guide](../docs/MIGRATION_GUIDE_SDK.md)** - Upgrading from v6.x to v7.0+
+- **[Examples](./EXAMPLES.md)** - Practical code examples by category
+
 ## Environment URLs
 
 - **Development**: `https://lpad-backend-dev1.defi.gala.com`