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

package/MIGRATING-TO-9.0.md

@@ -1,4 +1,4 @@
-# Migrating from launchpad-sdk 8.1.0 to 9.0.0-rc.0
+# Migrating from launchpad-sdk 8.1.0 to 9.0.0-rc.1
 
 Generated by `scripts/generate-migration-doc.ts` from the built declarations of the published
 `@gala-chain/launchpad-sdk@8.1.0` tarball and of this build (do not edit by hand).
@@ -14,7 +14,9 @@ both clients. See CHANGELOG.md for behaviour changes.
 
 | Removed export | Kind | Now |
 | --- | --- | --- |
+| `AuthenticatedEvent` | type | removed: the wire payload is `StreamChatAuthenticatedEvent` (`RealtimeEventPayloads['authenticated']`) |
 | `BaseBridgeStrategy` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
+| `BaseContentItem` | type | removed: `Message`: the item `GET /v1/messages` lists (`id` and `messageId`, `user`, `reactions: { counts, userReacted? }`) |
 | `BaseTokenCrossRate` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `BRIDGE_CONTRACT_ABI` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `BRIDGE_TOKEN_METADATA` | value | `STATIC_TOKEN_METADATA` from `@gala-chain/gala-core-sdk/bridge` |
@@ -41,7 +43,12 @@ both clients. See CHANGELOG.md for behaviour changes.
 | `BridgeTransactionRegistrationResponse` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `CHAIN_IDS` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `ChainResult` | type | removed: `sdk.tokens` (TokenWrites) is gone: `transferToken` / `burnTokens` / `lockTokens` / `unlockTokens` return receipts |
+| `ChatMessageItem` | type | removed: `Message` for a listed chat message; `SentChatMessage` / `EditedChatMessage` for what `sendChatMessage` / `updateChatMessage` answer |
+| `ChatStatusChangedEvent` | type | removed: the wire payload is `StreamChatStatusEvent` (`RealtimeEventPayloads['CHAT_STATUS_CHANGED']`) |
+| `CommentData` | type | removed: the shape of the removed `/v1/comments` route: a listed comment is `Message`, a written one `WrittenComment` |
+| `CommentItem` | type | removed: `Message` for a listed comment; `WrittenComment` for what `createComment` / `updateComment` answer |
 | `compareAmounts` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
+| `ConnectionEvent` | type | removed: the wire payload is `ConnectionGreetingEvent` (`RealtimeEventPayloads['connection']`) |
 | `createProviderFromEip1193` | value | same name, from `@gala-chain/gala-core-sdk/providers` |
 | `createProviderFromWallet` | value | `PrivateKeyProvider` from `@gala-chain/gala-core-sdk/providers` (`PrivateKeyProvider.fromWallet(wallet)`) |
 | `createSolanaWallet` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
@@ -57,6 +64,7 @@ both clients. See CHANGELOG.md for behaviour changes.
 | `DEFAULT_SOLANA_BRIDGE_PROGRAM` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `DEFAULT_SOLANA_RPC_URL` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `DEFAULT_SOLANA_TOKENS` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
+| `DeleteCommentOptions` | type | removed: the removed `/v1/comments` route: `deleteComment(messageId)` |
 | `DestinationChainTxFee` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `DetectedWallet` | type | same name, from `@gala-chain/gala-core-sdk/providers` |
 | `detectWallets` | value | same name, from `@gala-chain/gala-core-sdk/providers` |
@@ -69,6 +77,7 @@ both clients. See CHANGELOG.md for behaviour changes.
 | `EIP712Domain` | type | `EIP712DomainValue` from `@gala-chain/gala-core-sdk` |
 | `EIP712TypeField` | type | removed: one field of gala-core-sdk's `EIP712Types` (`EIP712Types[string][number]`) |
 | `EIP712Types` | type | same name, from `@gala-chain/gala-core-sdk` |
+| `EngagementStatsData` | type | removed: `fetchTokenStats` returns `TokenStatsData`: `{ holdersCount, chatMessageCount, commentCount, roomCount }`, what the backend sends |
 | `ensureConnected` | value | same name, from `@gala-chain/gala-core-sdk/providers` |
 | `ERC20_ABI` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `EstimateBridgeFeeParams` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
@@ -87,6 +96,8 @@ both clients. See CHANGELOG.md for behaviour changes.
 | `FetchBalancesResponse` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `FetchBridgeableTokensOptions` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `FetchBridgeableTokensResult` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
+| `FetchCommentsOptions` | type | removed: the removed `/v1/comments` route: `GetCommentsOptions` |
+| `FetchCommentsResult` | type | removed: the removed `/v1/comments` route: `CommentsResult` |
 | `FetchPriceHistoryOptions` | type | `PriceSeriesTimeframe` from `@gala-chain/gswap-sdk` (`getPriceSeries(token, timeframe)`) |
 | `FetchWrappableTokensOptions` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `FetchWrappableTokensResult` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
@@ -120,12 +131,23 @@ both clients. See CHANGELOG.md for behaviour changes.
 | `getStaticTokenMetadata` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `getWalletByRdns` | value | same name, from `@gala-chain/gala-core-sdk/providers` |
 | `GetWrappableTokenOptions` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
+| `GlobalFeedEvent` | type | removed: the global feed delivers the token-room payload types: `RealtimeEventPayloads`; `FeedTokenEvent` names each occurrence |
+| `GlobalFeedEventType` | type | removed: the feed events are the wire names (`FeedEventName`), not lowercase discriminators |
+| `GlobalFeedSiteConfigEvent` | type | removed: `SiteConfigChangedEvent` / `FeatureGlobalStatusEvent` |
+| `GlobalFeedSiteConfigEventType` | type | removed: the feed events are the wire names (`FeedEventName`) |
+| `GlobalFeedStatsUpdatedEvent` | type | removed: `StatsUpdatedEvent` |
+| `GlobalFeedSubscriptionOptions` | type | removed: `subscribeToGlobalFeed(callbacks)` returns an unsubscribe; there are no options |
+| `GlobalFeedTokenConfigUpdatedEvent` | type | removed: `TokenConfigUpdatedEvent` |
+| `GlobalFeedTokenEvent` | type | removed: `FeedTokenEvent`: `{ event, data }`, named by the wire event |
+| `GlobalFeedTokenEventType` | type | removed: the feed events are the wire names (`FeedTokenEventName`) |
 | `GSwap` | value | same name, from `@gala-chain/gswap-sdk` |
 | `hasAnyWallet` | value | same name, from `@gala-chain/gala-core-sdk/providers` |
 | `HttpRequestor` | type | same name, from `@gala-chain/gala-core-sdk` |
+| `isChatMessageItem` | value | removed: `isMessage` |
 | `isEip1193Provider` | value | same name, from `@gala-chain/gala-core-sdk/providers` |
 | `isExternalProvider` | value | same name, from `@gala-chain/gala-core-sdk/providers` |
 | `isPrivateKeyProvider` | value | same name, from `@gala-chain/gala-core-sdk/providers` |
+| `isStreamingEvent` | value | removed: `StreamingEventService` is deleted (nothing fed it) |
 | `IsTokenBridgeableOptions` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `IsTokenBridgeableResult` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `IsTokenWrappableResult` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
@@ -138,6 +160,9 @@ both clients. See CHANGELOG.md for behaviour changes.
 | `loadEnvWithFallback` | value | removed: demo tooling: load `.env` with dotenv in the app |
 | `LockInput` | type | removed: `sdk.tokens` (TokenWrites) is gone: `sdk.lockTokens({ tokens: [...] })` |
 | `MasteryTitle` | type | same name, from `@gala-chain/gswap-sdk` |
+| `ModeratedTokenInviteScope` | type | removed: `InviteScope` |
+| `PostCommentOptions` | type | removed: the removed `/v1/comments` route: `CreateCommentOptions` |
+| `PostCommentResult` | type | removed: the removed `/v1/comments` route: `CreateCommentResult` |
 | `PriceHistoryResult` | type | `PriceSeries` from `@gala-chain/gswap-sdk` (`gSwap.market.getPriceSeries(token, timeframe)` answers the whole series) |
 | `PriceSnapshot` | type | `PriceSeriesPoint` from `@gala-chain/gswap-sdk` |
 | `PriceSortOrder` | type | `PriceSeriesTimeframe` from `@gala-chain/gswap-sdk` (a series comes oldest first; sort it yourself) |
@@ -145,7 +170,11 @@ both clients. See CHANGELOG.md for behaviour changes.
 | `providerToWallet` | value | removed: `isPrivateKeyProvider(p) ? new Wallet(p.exportPrivateKey()) : undefined` (ethers stays the app's) |
 | `PublicKeyResult` | type | same name, from `@gala-chain/gala-core-sdk` |
 | `QuoteTokenCrossRate` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
+| `RecordingStatusChangedEvent` | type | removed: the wire payload is `RecordingStatusEvent` |
 | `RequestBridgeOutResponse` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
+| `RoomLeftEvent` | type | removed: the wire payload is `RoomAckEvent` |
+| `RoomSubscribedEvent` | type | removed: the wire payload is `RoomAckEvent` |
+| `SimulcastStatusChangedEvent` | type | removed: the wire payload is `SimulcastStatusEvent` |
 | `SOLANA_COMPUTE` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `SOLANA_DISCRIMINATORS` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `SolanaBridgeConfig` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
@@ -153,6 +182,13 @@ both clients. See CHANGELOG.md for behaviour changes.
 | `SolanaTokenConfig` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `SolanaTransactionStatus` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `SolanaWalletBalanceResult` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
+| `StreamCountdownUpdatedEvent` | type | removed: the wire payload is `StreamCountdownEvent` |
+| `StreamingEvent` | type | removed: `StreamingEventService` is deleted (nothing fed it): `RealtimeEventPayloads` types every event the socket delivers |
+| `StreamingEventCallback` | type | removed: `StreamingEventService` is deleted (nothing fed it): a subscriber is `RealtimeListener<'EVENT_NAME'>` |
+| `StreamingEventRegistry` | type | removed: `StreamingEventService` is deleted (nothing fed it): `StreamWebSocketService` keeps the one registry of subscribers |
+| `StreamingEventService` | value | removed: nothing fed it. The `LaunchpadSDK.on*` methods and `sdk.realtime.subscribe*` are subscribers of the `StreamWebSocketService` registry |
+| `StreamLanguageUpdatedEvent` | type | removed: the wire payload is `StreamLanguageEvent` |
+| `StreamStatusChangedEvent` | type | removed: the wire payload is `StreamStatusEvent` |
 | `stripHexPrefix` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `subscribeToWalletChanges` | value | same name, from `@gala-chain/gala-core-sdk/providers` |
 | `toBaseUnits` | value | same name, from `@gala-chain/gala-core-sdk/bridge` |
@@ -165,11 +201,17 @@ both clients. See CHANGELOG.md for behaviour changes.
 | `TokenIdentifier` | type | removed: `sdk.tokens` (TokenWrites) is gone: a token is a `TokenId` |
 | `TokenInstanceKey` | type | `GalaChainTokenInstanceKey` from `@gala-chain/gala-core-sdk` |
 | `TokenRoundTripResult` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
+| `TokenSubscribedEvent` | type | removed: the wire payload is `StreamSubscribedEvent` |
+| `TokenUnsubscribedEvent` | type | removed: the wire payload is `StreamUnsubscribedEvent` |
 | `TokenWrites` | value | removed: `sdk.tokens` is gone: `transferToken` / `burnTokens` / `lockTokens` / `unlockTokens`; or `GatewayWrites` (gala-core-sdk) |
+| `TRADES_QUERY_CONSTRAINTS` | value | removed: a deprecated composite: `TOKEN_NAME_DTO_CONSTRAINT` for the token name |
+| `TradesListResult` | type | removed: `TradesQueryResult`: the `{ trades, pageInfo }` `getTrades` returns |
 | `TransferInput` | type | removed: `sdk.tokens` (TokenWrites) is gone: `sdk.transferToken({ to, tokenId, amount })` |
 | `TypedDataDomain` | type | same name, from `@gala-chain/gala-core-sdk/providers` |
 | `TypedDataField` | type | same name, from `@gala-chain/gala-core-sdk/providers` |
 | `UnwrapTokenOptions` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
+| `UserTypingEvent` | type | removed: the wire payload is `TypingIndicatorEvent` |
+| `ViewerCountChangedEvent` | type | removed: the wire payload is `ViewerCountEvent` |
 | `WaitForBridgeOptions` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `WaitOptions` | type | same name, from `@gala-chain/gala-core-sdk/bridge` |
 | `WalletConnectionState` | type | same name, from `@gala-chain/gala-core-sdk/providers` |

package/README.md

@@ -12,7 +12,7 @@ pnpm add @gala-chain/launchpad-sdk@next @gala-chain/gala-core-sdk@next @gala-cha
 
 An install without `@next` gets 8.1.0. Pin the exact versions in an app build.
 
-`@gala-chain/gala-core-sdk` and the others are peer dependencies: install them next to this package. An app that bridges tokens also installs the bridge's own peers (`ethers`, `@solana/web3.js`, `@solana/spl-token`); this package loads `@gala-chain/gala-core-sdk/bridge` only at the first bridge or wrap call.
+`@gala-chain/gala-core-sdk` and the others are peer dependencies: install them next to this package. An app that bridges or wraps tokens installs the bridge's own peers (`ethers`, `@solana/web3.js`, `@solana/spl-token`) and hands the bridge module to the SDK: `new LaunchpadSDK({ ..., bridge: () => import('@gala-chain/gala-core-sdk/bridge') })` (loaded at the first bridge or wrap call). This package never loads that module or Solana itself, so an app that does not bridge bundles and installs neither; without the loader the bridge and wrap methods throw a `ConfigurationError` naming the `bridge` option.
 
 For the DEX, install `@gala-chain/gswap-sdk` 2.0 (also under `next`) next to this package: `pnpm add @gala-chain/gswap-sdk@next`.