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

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

@@ -2456,6 +2456,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 +2716,11 @@ 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
+
 ### Demo Scripts
 
 The SDK includes 36 comprehensive demo scripts organized into logical categories for easy discovery and learning.
@@ -3042,6 +3063,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...',
+  limit: 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`