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

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
 });
 ```
 
@@ -2721,6 +2732,13 @@ npm run lint
 - [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.
@@ -2947,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
@@ -3029,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
 
@@ -3039,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
 }
 
@@ -3099,7 +3117,7 @@ New methods for accessing user information:
 // Fetch user token balances
 const balances = await sdk.fetchUserBalances({
   address: '0x...',
-  limit: 50
+  pageSize: 50
 });
 
 // Get comprehensive user report (Overseer only)