@gala-chain/launchpad-sdk 5.0.4-beta.63 → 5.0.4-beta.64
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/LaunchpadSDK.d.ts +20 -8
- package/dist/LaunchpadSDK.d.ts.map +1 -1
- package/dist/ai-docs.json +354 -314
- package/dist/config/environments.d.ts +2 -0
- package/dist/config/environments.d.ts.map +1 -1
- package/dist/constants/version.generated.d.ts +1 -1
- package/dist/index.browser.d.ts +2 -1
- package/dist/index.browser.d.ts.map +1 -1
- package/dist/index.browser.esm.js +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/dist/native.cjs +1 -1
- package/dist/native.esm.js +1 -1
- package/dist/services/DexBackendTradeClient.d.ts +34 -0
- package/dist/services/DexBackendTradeClient.d.ts.map +1 -0
- package/dist/services/DexQuoteService.d.ts +19 -19
- package/dist/services/DexQuoteService.d.ts.map +1 -1
- package/dist/services/GSwapLiquidityMutationService.d.ts +2 -2
- package/dist/services/GSwapLiquidityMutationService.d.ts.map +1 -1
- package/dist/services/GSwapLiquidityQueryService.d.ts +2 -2
- package/dist/services/GSwapLiquidityQueryService.d.ts.map +1 -1
- package/dist/services/GSwapPoolQueryService.d.ts +5 -6
- package/dist/services/GSwapPoolQueryService.d.ts.map +1 -1
- package/dist/services/GSwapService.d.ts +6 -6
- package/dist/services/GSwapService.d.ts.map +1 -1
- package/dist/services/GSwapSwapService.d.ts +0 -2
- package/dist/services/GSwapSwapService.d.ts.map +1 -1
- package/dist/services/GdexStreamService.d.ts +133 -0
- package/dist/services/GdexStreamService.d.ts.map +1 -0
- package/dist/src/LaunchpadSDK.d.ts +20 -8
- package/dist/src/LaunchpadSDK.d.ts.map +1 -1
- package/dist/src/config/environments.d.ts +2 -0
- package/dist/src/config/environments.d.ts.map +1 -1
- package/dist/src/constants/version.generated.d.ts +1 -1
- package/dist/src/index.browser.d.ts +2 -1
- package/dist/src/index.browser.d.ts.map +1 -1
- package/dist/src/services/DexBackendTradeClient.d.ts +34 -0
- package/dist/src/services/DexBackendTradeClient.d.ts.map +1 -0
- package/dist/src/services/DexQuoteService.d.ts +19 -19
- package/dist/src/services/DexQuoteService.d.ts.map +1 -1
- package/dist/src/services/GSwapLiquidityMutationService.d.ts +2 -2
- package/dist/src/services/GSwapLiquidityMutationService.d.ts.map +1 -1
- package/dist/src/services/GSwapLiquidityQueryService.d.ts +2 -2
- package/dist/src/services/GSwapLiquidityQueryService.d.ts.map +1 -1
- package/dist/src/services/GSwapPoolQueryService.d.ts +5 -6
- package/dist/src/services/GSwapPoolQueryService.d.ts.map +1 -1
- package/dist/src/services/GSwapService.d.ts +6 -6
- package/dist/src/services/GSwapService.d.ts.map +1 -1
- package/dist/src/services/GSwapSwapService.d.ts +0 -2
- package/dist/src/services/GSwapSwapService.d.ts.map +1 -1
- package/dist/src/services/GdexStreamService.d.ts +133 -0
- package/dist/src/services/GdexStreamService.d.ts.map +1 -0
- package/dist/src/types/composite-pool.dto.d.ts +0 -2
- package/dist/src/types/composite-pool.dto.d.ts.map +1 -1
- package/dist/src/utils/error-utils.d.ts +5 -0
- package/dist/src/utils/error-utils.d.ts.map +1 -1
- package/dist/src/utils/errors.d.ts +4 -0
- package/dist/src/utils/errors.d.ts.map +1 -1
- package/dist/types/composite-pool.dto.d.ts +0 -2
- package/dist/types/composite-pool.dto.d.ts.map +1 -1
- package/dist/utils/error-utils.d.ts +5 -0
- package/dist/utils/error-utils.d.ts.map +1 -1
- package/dist/utils/errors.d.ts +4 -0
- package/dist/utils/errors.d.ts.map +1 -1
- package/package.json +42 -11
- package/dist/services/GalaChainGatewayClient.d.ts +0 -227
- package/dist/services/GalaChainGatewayClient.d.ts.map +0 -1
- package/dist/src/services/GalaChainGatewayClient.d.ts +0 -227
- package/dist/src/services/GalaChainGatewayClient.d.ts.map +0 -1
package/dist/ai-docs.json
CHANGED
|
@@ -1,9 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"meta": {
|
|
3
|
-
"version": "5.0.4-beta.
|
|
4
|
-
"generatedAt": "2026-
|
|
3
|
+
"version": "5.0.4-beta.64",
|
|
4
|
+
"generatedAt": "2026-07-11T07:59:52.294Z",
|
|
5
5
|
"toolCount": 317,
|
|
6
|
-
"categoryCount": 39
|
|
6
|
+
"categoryCount": 39,
|
|
7
|
+
"warnings": [
|
|
8
|
+
"Auth metadata missing from manifest for 6 tool(s); used heuristic fallback: gala_launchpad_fetch_client_flags, gala_launchpad_fetch_notification_preferences, gala_launchpad_flush_cache_wallet_aliases, gala_launchpad_register_push_token, gala_launchpad_unregister_push_token, gala_launchpad_update_notification_preferences"
|
|
9
|
+
]
|
|
7
10
|
},
|
|
8
11
|
"categories": {
|
|
9
12
|
"pools": {
|
|
@@ -252,17 +255,17 @@
|
|
|
252
255
|
"messages": {
|
|
253
256
|
"key": "messages",
|
|
254
257
|
"label": "Messages",
|
|
255
|
-
"description": "
|
|
256
|
-
"icon": "
|
|
258
|
+
"description": "Unified chat and comment message operations",
|
|
259
|
+
"icon": "✉️",
|
|
257
260
|
"count": 8,
|
|
258
261
|
"read": 5,
|
|
259
262
|
"write": 3
|
|
260
263
|
},
|
|
261
264
|
"restricted-names": {
|
|
262
265
|
"key": "restricted-names",
|
|
263
|
-
"label": "Restricted
|
|
264
|
-
"description": "Restricted
|
|
265
|
-
"icon": "
|
|
266
|
+
"label": "Restricted Names",
|
|
267
|
+
"description": "Restricted token name administration",
|
|
268
|
+
"icon": "🛑",
|
|
266
269
|
"count": 2,
|
|
267
270
|
"read": 1,
|
|
268
271
|
"write": 1
|
|
@@ -288,62 +291,62 @@
|
|
|
288
291
|
"holders": {
|
|
289
292
|
"key": "holders",
|
|
290
293
|
"label": "Holders",
|
|
291
|
-
"description": "
|
|
292
|
-
"icon": "
|
|
294
|
+
"description": "Token holder rankings, distribution, and history",
|
|
295
|
+
"icon": "👥",
|
|
293
296
|
"count": 5,
|
|
294
297
|
"read": 5,
|
|
295
298
|
"write": 0
|
|
296
299
|
},
|
|
297
300
|
"global-feed": {
|
|
298
301
|
"key": "global-feed",
|
|
299
|
-
"label": "Global
|
|
300
|
-
"description": "
|
|
301
|
-
"icon": "
|
|
302
|
+
"label": "Global Feed",
|
|
303
|
+
"description": "Real-time global event feed subscriptions",
|
|
304
|
+
"icon": "🌐",
|
|
302
305
|
"count": 5,
|
|
303
306
|
"read": 5,
|
|
304
307
|
"write": 0
|
|
305
308
|
},
|
|
306
309
|
"websocket-admin": {
|
|
307
310
|
"key": "websocket-admin",
|
|
308
|
-
"label": "
|
|
309
|
-
"description": "
|
|
310
|
-
"icon": "
|
|
311
|
+
"label": "WebSocket Admin",
|
|
312
|
+
"description": "WebSocket event emission and connection administration",
|
|
313
|
+
"icon": "🛰️",
|
|
311
314
|
"count": 24,
|
|
312
315
|
"read": 18,
|
|
313
316
|
"write": 6
|
|
314
317
|
},
|
|
315
318
|
"ai-moderation": {
|
|
316
319
|
"key": "ai-moderation",
|
|
317
|
-
"label": "
|
|
318
|
-
"description": "
|
|
319
|
-
"icon": "
|
|
320
|
+
"label": "AI Moderation",
|
|
321
|
+
"description": "AI-assisted content moderation and settings",
|
|
322
|
+
"icon": "🤖",
|
|
320
323
|
"count": 5,
|
|
321
324
|
"read": 4,
|
|
322
325
|
"write": 1
|
|
323
326
|
},
|
|
324
327
|
"weekly-challenge": {
|
|
325
328
|
"key": "weekly-challenge",
|
|
326
|
-
"label": "Weekly
|
|
327
|
-
"description": "Weekly
|
|
328
|
-
"icon": "
|
|
329
|
+
"label": "Weekly Challenge",
|
|
330
|
+
"description": "Weekly token challenge leaderboards and history",
|
|
331
|
+
"icon": "🏆",
|
|
329
332
|
"count": 2,
|
|
330
333
|
"read": 2,
|
|
331
334
|
"write": 0
|
|
332
335
|
},
|
|
333
336
|
"oembed": {
|
|
334
337
|
"key": "oembed",
|
|
335
|
-
"label": "
|
|
336
|
-
"description": "
|
|
337
|
-
"icon": "
|
|
338
|
+
"label": "OEmbed",
|
|
339
|
+
"description": "Social preview metadata for Launchpad pages",
|
|
340
|
+
"icon": "🔖",
|
|
338
341
|
"count": 3,
|
|
339
342
|
"read": 3,
|
|
340
343
|
"write": 0
|
|
341
344
|
},
|
|
342
345
|
"platform-stats": {
|
|
343
346
|
"key": "platform-stats",
|
|
344
|
-
"label": "Platform
|
|
345
|
-
"description": "Platform-
|
|
346
|
-
"icon": "
|
|
347
|
+
"label": "Platform Stats",
|
|
348
|
+
"description": "Platform-wide trading and token statistics",
|
|
349
|
+
"icon": "📊",
|
|
347
350
|
"count": 1,
|
|
348
351
|
"read": 1,
|
|
349
352
|
"write": 0
|
|
@@ -351,8 +354,8 @@
|
|
|
351
354
|
"notifications": {
|
|
352
355
|
"key": "notifications",
|
|
353
356
|
"label": "Notifications",
|
|
354
|
-
"description": "
|
|
355
|
-
"icon": "
|
|
357
|
+
"description": "Push notification and client preference management",
|
|
358
|
+
"icon": "🔔",
|
|
356
359
|
"count": 5,
|
|
357
360
|
"read": 4,
|
|
358
361
|
"write": 1
|
|
@@ -368,8 +371,11 @@
|
|
|
368
371
|
"trading",
|
|
369
372
|
"trades",
|
|
370
373
|
"balance",
|
|
374
|
+
"holders",
|
|
371
375
|
"creation",
|
|
372
|
-
"referrals"
|
|
376
|
+
"referrals",
|
|
377
|
+
"weekly-challenge",
|
|
378
|
+
"platform-stats"
|
|
373
379
|
]
|
|
374
380
|
},
|
|
375
381
|
{
|
|
@@ -401,8 +407,12 @@
|
|
|
401
407
|
"simulcasts",
|
|
402
408
|
"chat",
|
|
403
409
|
"chat-messages",
|
|
410
|
+
"messages",
|
|
404
411
|
"comments",
|
|
405
|
-
"content-reactions"
|
|
412
|
+
"content-reactions",
|
|
413
|
+
"global-feed",
|
|
414
|
+
"notifications",
|
|
415
|
+
"oembed"
|
|
406
416
|
]
|
|
407
417
|
},
|
|
408
418
|
{
|
|
@@ -415,7 +425,10 @@
|
|
|
415
425
|
"api-keys",
|
|
416
426
|
"moderators",
|
|
417
427
|
"content-flags",
|
|
418
|
-
"overseers"
|
|
428
|
+
"overseers",
|
|
429
|
+
"restricted-names",
|
|
430
|
+
"websocket-admin",
|
|
431
|
+
"ai-moderation"
|
|
419
432
|
]
|
|
420
433
|
},
|
|
421
434
|
{
|
|
@@ -723,7 +736,7 @@
|
|
|
723
736
|
"name": "fetchTokenSpotPrice",
|
|
724
737
|
"mcpTool": "gala_launchpad_fetch_token_spot_price",
|
|
725
738
|
"category": "pools",
|
|
726
|
-
"description": "Fetch USD spot price for ANY token with smart routing\n\nRoutes to the correct backend automatically:\n- **tokenName** → Launchpad token (detects graduation status)\n- **tokenId** → DEX token via /v1/trade/price
|
|
739
|
+
"description": "Fetch USD spot price for ANY token with smart routing\n\nRoutes to the correct backend automatically:\n- **tokenName** → Launchpad token (detects graduation status)\n- **tokenId** → REST-backed DEX token price via /v1/trade/price (~1s freshness; no signer required).\n\nDEX read errors: restricted or ungraduated tokens return TokenRestrictedError (403), a missing pool returns a not-found error, and heavy usage may return 429 rate limit.",
|
|
727
740
|
"operationType": "read",
|
|
728
741
|
"authRequired": false,
|
|
729
742
|
"parameters": [
|
|
@@ -938,7 +951,7 @@
|
|
|
938
951
|
"category": "pools",
|
|
939
952
|
"description": "Validate if token name and/or symbol are available for use.\n\nCheck name and symbol availability before launching a token. Returns availability flags\nand any validation errors. Useful for token creation forms to prevent invalid submissions.\n\nRETURNS: { nameAvailable, symbolAvailable, nameBlocklisted, symbolBlocklisted, errors: [] }\n\nAuthentication: None required (public endpoint)",
|
|
940
953
|
"operationType": "read",
|
|
941
|
-
"authRequired":
|
|
954
|
+
"authRequired": false,
|
|
942
955
|
"parameters": [
|
|
943
956
|
{
|
|
944
957
|
"name": "tokenName",
|
|
@@ -1011,7 +1024,7 @@
|
|
|
1011
1024
|
"category": "pools",
|
|
1012
1025
|
"description": "Watch for new DEX pool creation events in real-time.",
|
|
1013
1026
|
"operationType": "read",
|
|
1014
|
-
"authRequired":
|
|
1027
|
+
"authRequired": false,
|
|
1015
1028
|
"parameters": [
|
|
1016
1029
|
{
|
|
1017
1030
|
"name": "minTVL",
|
|
@@ -1046,7 +1059,7 @@
|
|
|
1046
1059
|
"category": "pools",
|
|
1047
1060
|
"description": "Watch for new launchpad token creation events in real-time.",
|
|
1048
1061
|
"operationType": "write",
|
|
1049
|
-
"authRequired":
|
|
1062
|
+
"authRequired": false,
|
|
1050
1063
|
"parameters": [
|
|
1051
1064
|
{
|
|
1052
1065
|
"name": "creatorAddress",
|
|
@@ -1097,7 +1110,7 @@
|
|
|
1097
1110
|
"category": "pools",
|
|
1098
1111
|
"description": "Watch for pool metadata updates in real-time.\n\nTriggers when pool metadata, social links, or badges are updated. Includes:\n- POOL_METADATA_UPDATED: Name, description, image, category changes\n- POOL_SOCIAL_LINKS_UPDATED: Website, Discord, Twitter, etc. changes\n- POOL_BADGE_ASSIGNED: New badges or badge assignments\n\nReturns:\n- poolsUpdated: Number of pool updates detected\n- updates: Array of pool update events with tokenName, updateType, and metadata changes\n\nFilter Options:\n- tokenName: Only watch updates for a specific token\n- updateType: Filter by type ('METADATA', 'SOCIAL_LINKS', or 'BADGE_ASSIGNED').",
|
|
1099
1112
|
"operationType": "write",
|
|
1100
|
-
"authRequired":
|
|
1113
|
+
"authRequired": false,
|
|
1101
1114
|
"parameters": [
|
|
1102
1115
|
{
|
|
1103
1116
|
"name": "tokenName",
|
|
@@ -1152,7 +1165,7 @@
|
|
|
1152
1165
|
"category": "pools",
|
|
1153
1166
|
"description": "Watch for token holder count changes in real-time.\n\nTriggers whenever the holder count for a token changes, including:\n- New holders making their first purchase\n- Holders liquidating their entire position\n- Changes in holder distribution and tiers\n\nReturns:\n- holdersChanged: Number of holder count change events detected\n- events: Array of holder count events with tokenName, newCount, previousCount, and timestamp\n\nFilter Options:\n- tokenName: Only watch holder changes for a specific token\n- minThreshold: Only notify if holder count changes by >= minThreshold.",
|
|
1154
1167
|
"operationType": "read",
|
|
1155
|
-
"authRequired":
|
|
1168
|
+
"authRequired": false,
|
|
1156
1169
|
"parameters": [
|
|
1157
1170
|
{
|
|
1158
1171
|
"name": "tokenName",
|
|
@@ -1186,7 +1199,7 @@
|
|
|
1186
1199
|
"category": "pools",
|
|
1187
1200
|
"description": "Update token configuration (messages, comments, and social links).\n\nUpdate messaging configuration and/or social media links for a token.\nAt least one field must be provided.\n\n**Authorization:**\n- Token owner (JWT auth)\n- Platform admin (API key)\n\nRETURNS: void (success with no content)\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth (token owner)",
|
|
1188
1201
|
"operationType": "write",
|
|
1189
|
-
"authRequired":
|
|
1202
|
+
"authRequired": false,
|
|
1190
1203
|
"parameters": [
|
|
1191
1204
|
{
|
|
1192
1205
|
"name": "tokenName",
|
|
@@ -1340,7 +1353,7 @@
|
|
|
1340
1353
|
"category": "trading",
|
|
1341
1354
|
"description": "Execute token purchase with slippage protection.\n\nWORKFLOW:\n1. calculateBuyAmount() -> Get expected output (result.amount AND result.reverseBondingCurveFee)\n2. buy() -> Execute trade with BOTH expectedAmount AND maxAcceptableReverseBondingCurveFee\n3. fetchTrades() -> Verify trade completed\n\nCRITICAL: Extract BOTH parameters from calculateBuyAmount:\n- result.amount -> expectedAmount\n- result.reverseBondingCurveFee -> maxAcceptableReverseBondingCurveFee\nOmitting reverseBondingCurveFee may cause transaction failures!\n\nRETURNS: Transaction details including input/output amounts and transaction ID.",
|
|
1342
1355
|
"operationType": "write",
|
|
1343
|
-
"authRequired":
|
|
1356
|
+
"authRequired": false,
|
|
1344
1357
|
"parameters": [
|
|
1345
1358
|
{
|
|
1346
1359
|
"name": "tokenName",
|
|
@@ -1403,7 +1416,7 @@
|
|
|
1403
1416
|
"category": "trading",
|
|
1404
1417
|
"description": "Execute token sale with slippage protection.\n\nWORKFLOW:\n1. calculateSellAmount() -> Get expected output (result.amount AND result.reverseBondingCurveFee)\n2. sell() -> Execute trade with BOTH expectedAmount AND maxAcceptableReverseBondingCurveFee\n3. fetchTrades() -> Verify trade completed\n\nCRITICAL: Extract BOTH parameters from calculateSellAmount:\n- result.amount -> expectedAmount\n- result.reverseBondingCurveFee -> maxAcceptableReverseBondingCurveFee\nOmitting reverseBondingCurveFee may cause transaction failures!\n\nRETURNS: Transaction details including input/output amounts and transaction ID.",
|
|
1405
1418
|
"operationType": "write",
|
|
1406
|
-
"authRequired":
|
|
1419
|
+
"authRequired": false,
|
|
1407
1420
|
"parameters": [
|
|
1408
1421
|
{
|
|
1409
1422
|
"name": "tokenName",
|
|
@@ -1599,7 +1612,7 @@
|
|
|
1599
1612
|
"category": "trading",
|
|
1600
1613
|
"description": "Graduate a token pool by buying all remaining tokens in one transaction.\n\nWORKFLOW (automatic):\n1. Calls calculateBuyAmountForGraduation() internally\n2. Executes buy() with exact remaining token amount\n3. Returns transaction result\n\nPerformance optimization: Provide currentSupply to avoid fetching pool details twice.\n\nCRITICAL: This is a convenience method that combines multiple operations.\nThrows error if token is already graduated.\nslippageToleranceFactor is optional and uses SDK defaults if not provided.\n\nRETURNS: TradeResult with transaction details including amounts and transaction ID.",
|
|
1601
1614
|
"operationType": "read",
|
|
1602
|
-
"authRequired":
|
|
1615
|
+
"authRequired": false,
|
|
1603
1616
|
"parameters": [
|
|
1604
1617
|
{
|
|
1605
1618
|
"name": "tokenName",
|
|
@@ -1885,7 +1898,7 @@
|
|
|
1885
1898
|
"name": "getSwapQuoteExactInput",
|
|
1886
1899
|
"mcpTool": "gala_launchpad_get_swap_quote_exact_input",
|
|
1887
1900
|
"category": "dex",
|
|
1888
|
-
"description": "Get swap quote for exact input amount
|
|
1901
|
+
"description": "Get a REST-backed swap quote for an exact input amount from the DEX backend (~1s freshness; no signer required). Specify how much you want to spend. Returns estimated output amount, fee tier, and price impact percentage. Restricted tokens return TokenRestrictedError (403), missing pools return a not-found error, and heavy usage may return 429 rate limit.",
|
|
1889
1902
|
"operationType": "read",
|
|
1890
1903
|
"authRequired": false,
|
|
1891
1904
|
"parameters": [
|
|
@@ -1914,7 +1927,7 @@
|
|
|
1914
1927
|
"name": "getSwapQuoteExactOutput",
|
|
1915
1928
|
"mcpTool": "gala_launchpad_get_swap_quote_exact_output",
|
|
1916
1929
|
"category": "dex",
|
|
1917
|
-
"description": "Get swap quote for exact output amount
|
|
1930
|
+
"description": "Get a REST-backed swap quote for an exact output amount from the DEX backend (~1s freshness; no signer required). Specify how much you want to receive. Returns required input amount, fee tier, and price impact percentage. Restricted tokens return TokenRestrictedError (403), missing pools return a not-found error, and heavy usage may return 429 rate limit.",
|
|
1918
1931
|
"operationType": "read",
|
|
1919
1932
|
"authRequired": false,
|
|
1920
1933
|
"parameters": [
|
|
@@ -1943,7 +1956,7 @@
|
|
|
1943
1956
|
"name": "calculateDexPoolQuoteLocal",
|
|
1944
1957
|
"mcpTool": "gala_launchpad_calculate_dex_pool_quote_local",
|
|
1945
1958
|
"category": "dex",
|
|
1946
|
-
"description": "Calculate instant DEX quote using local
|
|
1959
|
+
"description": "Calculate an instant DEX quote using local math with zero network access for the calculation. Provide compositePoolData for a fully local operation; otherwise pool state is fetched from the DEX backend (~1s freshness; no signer required). Backend fetches can return TokenRestrictedError (403) for restricted tokens, a not-found error for missing pools, or 429 under heavy usage.",
|
|
1947
1960
|
"operationType": "read",
|
|
1948
1961
|
"authRequired": false,
|
|
1949
1962
|
"parameters": [
|
|
@@ -2000,7 +2013,7 @@
|
|
|
2000
2013
|
"name": "calculateDexPoolQuoteExternal",
|
|
2001
2014
|
"mcpTool": "gala_launchpad_calculate_dex_pool_quote_external",
|
|
2002
2015
|
"category": "dex",
|
|
2003
|
-
"description": "
|
|
2016
|
+
"description": "Get a server-computed real-time quote via the DEX backend (~1s freshness; no signer required). Use for final price verification. Restricted tokens return TokenRestrictedError (403), missing pools return a not-found error, and heavy usage may return 429 rate limit.",
|
|
2004
2017
|
"operationType": "read",
|
|
2005
2018
|
"authRequired": false,
|
|
2006
2019
|
"parameters": [
|
|
@@ -2053,7 +2066,7 @@
|
|
|
2053
2066
|
"category": "dex",
|
|
2054
2067
|
"description": "Execute a token swap on GalaSwap DEX with slippage protection. Get a quote first using getSwapQuote tools.",
|
|
2055
2068
|
"operationType": "write",
|
|
2056
|
-
"authRequired":
|
|
2069
|
+
"authRequired": false,
|
|
2057
2070
|
"parameters": [
|
|
2058
2071
|
{
|
|
2059
2072
|
"name": "fromToken",
|
|
@@ -2137,7 +2150,7 @@
|
|
|
2137
2150
|
"name": "fetchDexPools",
|
|
2138
2151
|
"mcpTool": "gala_launchpad_fetch_dex_pools",
|
|
2139
2152
|
"category": "dex-pools",
|
|
2140
|
-
"description": "Fetch DEX
|
|
2153
|
+
"description": "Fetch REST-backed DEX pool data with cursor-based pagination and filtering (~1s freshness; no signer required). Heavy usage may return 429 rate limit.",
|
|
2141
2154
|
"operationType": "read",
|
|
2142
2155
|
"authRequired": false,
|
|
2143
2156
|
"parameters": [
|
|
@@ -2187,7 +2200,7 @@
|
|
|
2187
2200
|
"name": "fetchAllDexPools",
|
|
2188
2201
|
"mcpTool": "gala_launchpad_fetch_all_dex_pools",
|
|
2189
2202
|
"category": "dex-pools",
|
|
2190
|
-
"description": "Fetch all DEX
|
|
2203
|
+
"description": "Fetch all REST-backed DEX pool data with automatic pagination (~1s freshness; no signer required). No page/limit parameters are needed; returns all pools matching filters. Heavy usage may return 429 rate limit.",
|
|
2191
2204
|
"operationType": "read",
|
|
2192
2205
|
"authRequired": false,
|
|
2193
2206
|
"parameters": [
|
|
@@ -2222,7 +2235,7 @@
|
|
|
2222
2235
|
"name": "withPrices",
|
|
2223
2236
|
"type": "boolean",
|
|
2224
2237
|
"required": false,
|
|
2225
|
-
"description": "Whether to fetch
|
|
2238
|
+
"description": "Whether to fetch REST-backed pricing data for each pool with ~1s freshness (default: false; no signer required)."
|
|
2226
2239
|
}
|
|
2227
2240
|
],
|
|
2228
2241
|
"topic": "fetch-dex-pools"
|
|
@@ -2231,7 +2244,7 @@
|
|
|
2231
2244
|
"name": "getSwapPoolInfo",
|
|
2232
2245
|
"mcpTool": "gala_launchpad_get_swap_pool_info",
|
|
2233
2246
|
"category": "dex-pools",
|
|
2234
|
-
"description": "Get liquidity and fee tier information for a token pair
|
|
2247
|
+
"description": "Get REST-backed liquidity and fee tier information for a token pair from the DEX backend (~1s freshness; no signer required). Restricted tokens return TokenRestrictedError (403), missing pools return a not-found error, and heavy usage may return 429 rate limit.",
|
|
2235
2248
|
"operationType": "read",
|
|
2236
2249
|
"authRequired": false,
|
|
2237
2250
|
"parameters": [
|
|
@@ -2254,7 +2267,7 @@
|
|
|
2254
2267
|
"name": "fetchCompositePoolData",
|
|
2255
2268
|
"mcpTool": "gala_launchpad_fetch_composite_pool_data",
|
|
2256
2269
|
"category": "dex-pools",
|
|
2257
|
-
"description": "Fetch complete pool state for
|
|
2270
|
+
"description": "Fetch complete pool state from the REST-backed DEX backend (~1s freshness; no signer required) for local DEX quote calculations. Returns pool liquidity, tick data, and token balances. Use this for bulk pricing operations or when you need multiple quotes for the same pool. Restricted tokens return TokenRestrictedError (403), missing pools return a not-found error, and heavy usage may return 429 rate limit.",
|
|
2258
2271
|
"operationType": "read",
|
|
2259
2272
|
"authRequired": false,
|
|
2260
2273
|
"parameters": [
|
|
@@ -2288,7 +2301,7 @@
|
|
|
2288
2301
|
"name": "getSwapPoolPrice",
|
|
2289
2302
|
"mcpTool": "gala_launchpad_get_swap_pool_price",
|
|
2290
2303
|
"category": "dex-pools",
|
|
2291
|
-
"description": "Get
|
|
2304
|
+
"description": "Get REST-backed price, tick, and liquidity for a DEX pool (~1s freshness; no signer required). Use to check if liquidity positions are in-range. Restricted tokens return TokenRestrictedError (403), missing pools return a not-found error, and heavy usage may return 429 rate limit.",
|
|
2292
2305
|
"operationType": "read",
|
|
2293
2306
|
"authRequired": false,
|
|
2294
2307
|
"parameters": [
|
|
@@ -2368,7 +2381,7 @@
|
|
|
2368
2381
|
"name": "getUserLiquidityPositions",
|
|
2369
2382
|
"mcpTool": "gala_launchpad_get_user_liquidity_positions",
|
|
2370
2383
|
"category": "dex-liquidity",
|
|
2371
|
-
"description": "Get
|
|
2384
|
+
"description": "Get REST-backed open liquidity positions for a wallet address with optional pagination and pricing (~1s freshness; no signer required). Bookmark pagination and pricing options are mutually exclusive; use getAllUserLiquidityPositionsTool for pricing with auto-pagination. Restricted tokens return TokenRestrictedError (403), missing pools return a not-found error, and heavy usage may return 429 rate limit.",
|
|
2372
2385
|
"operationType": "read",
|
|
2373
2386
|
"authRequired": false,
|
|
2374
2387
|
"parameters": [
|
|
@@ -2394,7 +2407,7 @@
|
|
|
2394
2407
|
"name": "withPrices",
|
|
2395
2408
|
"type": "boolean",
|
|
2396
2409
|
"required": false,
|
|
2397
|
-
"description": "Whether to fetch
|
|
2410
|
+
"description": "Whether to fetch REST-backed pricing for each position with ~1s freshness (optional, default: false; no signer required). Cannot be used together with bookmark - if you need pagination, use bookmark without withPrices. Pricing concurrency is controlled by SDK-level pricingConcurrency configuration."
|
|
2398
2411
|
}
|
|
2399
2412
|
]
|
|
2400
2413
|
},
|
|
@@ -2402,7 +2415,7 @@
|
|
|
2402
2415
|
"name": "getAllUserLiquidityPositions",
|
|
2403
2416
|
"mcpTool": "gala_launchpad_get_all_user_liquidity_positions",
|
|
2404
2417
|
"category": "dex-liquidity",
|
|
2405
|
-
"description": "Get
|
|
2418
|
+
"description": "Get all REST-backed open liquidity positions for a wallet address with automatic pagination and optional pricing (~1s freshness; no signer required). Restricted tokens return TokenRestrictedError (403), missing pools return a not-found error, and heavy usage may return 429 rate limit.",
|
|
2406
2419
|
"operationType": "read",
|
|
2407
2420
|
"authRequired": false,
|
|
2408
2421
|
"parameters": [
|
|
@@ -2416,7 +2429,7 @@
|
|
|
2416
2429
|
"name": "withPrices",
|
|
2417
2430
|
"type": "boolean",
|
|
2418
2431
|
"required": false,
|
|
2419
|
-
"description": "Whether to fetch
|
|
2432
|
+
"description": "Whether to fetch REST-backed pricing for each position with ~1s freshness (optional, default: false; no signer required). Pricing concurrency is controlled by SDK-level pricingConcurrency configuration."
|
|
2420
2433
|
}
|
|
2421
2434
|
]
|
|
2422
2435
|
},
|
|
@@ -2424,7 +2437,7 @@
|
|
|
2424
2437
|
"name": "getLiquidityPositionById",
|
|
2425
2438
|
"mcpTool": "gala_launchpad_get_liquidity_position_by_id",
|
|
2426
2439
|
"category": "dex-liquidity",
|
|
2427
|
-
"description": "Get
|
|
2440
|
+
"description": "Get REST-backed liquidity position details by position ID, including tokens, tick range, and accumulated fees (~1s freshness; no signer required). Restricted tokens return TokenRestrictedError (403), a missing pool or position returns a not-found error, and heavy usage may return 429 rate limit.",
|
|
2428
2441
|
"operationType": "read",
|
|
2429
2442
|
"authRequired": false,
|
|
2430
2443
|
"parameters": [
|
|
@@ -2446,7 +2459,7 @@
|
|
|
2446
2459
|
"name": "getLiquidityPosition",
|
|
2447
2460
|
"mcpTool": "gala_launchpad_get_liquidity_position",
|
|
2448
2461
|
"category": "dex-liquidity",
|
|
2449
|
-
"description": "Get liquidity position for a
|
|
2462
|
+
"description": "Get a REST-backed liquidity position for a token pair and price range (~1s freshness; no signer required). Restricted tokens return TokenRestrictedError (403), a missing pool or position returns a not-found error, and heavy usage may return 429 rate limit.",
|
|
2450
2463
|
"operationType": "read",
|
|
2451
2464
|
"authRequired": false,
|
|
2452
2465
|
"parameters": [
|
|
@@ -2497,9 +2510,9 @@
|
|
|
2497
2510
|
"name": "estimateRemoveLiquidity",
|
|
2498
2511
|
"mcpTool": "gala_launchpad_estimate_remove_liquidity",
|
|
2499
2512
|
"category": "dex-liquidity",
|
|
2500
|
-
"description": "Estimate tokens received when removing liquidity
|
|
2513
|
+
"description": "Estimate tokens received when removing liquidity using REST-backed DEX pool state (~1s freshness; no signer required). Returns amount0 and amount1 (underlying token amounts, raw without slippage adjustment). Restricted tokens return TokenRestrictedError (403), a missing pool or position returns a not-found error, and heavy usage may return 429 rate limit.",
|
|
2501
2514
|
"operationType": "read",
|
|
2502
|
-
"authRequired":
|
|
2515
|
+
"authRequired": false,
|
|
2503
2516
|
"parameters": [
|
|
2504
2517
|
{
|
|
2505
2518
|
"name": "token0",
|
|
@@ -2556,7 +2569,7 @@
|
|
|
2556
2569
|
"category": "dex-liquidity",
|
|
2557
2570
|
"description": "Add liquidity to a pool by specifying min/max price boundaries (SDK calculates tick boundaries).",
|
|
2558
2571
|
"operationType": "write",
|
|
2559
|
-
"authRequired":
|
|
2572
|
+
"authRequired": false,
|
|
2560
2573
|
"parameters": [
|
|
2561
2574
|
{
|
|
2562
2575
|
"name": "token0",
|
|
@@ -2625,7 +2638,7 @@
|
|
|
2625
2638
|
"category": "dex-liquidity",
|
|
2626
2639
|
"description": "Add liquidity to a pool by specifying exact tick boundaries (advanced usage).",
|
|
2627
2640
|
"operationType": "write",
|
|
2628
|
-
"authRequired":
|
|
2641
|
+
"authRequired": false,
|
|
2629
2642
|
"parameters": [
|
|
2630
2643
|
{
|
|
2631
2644
|
"name": "token0",
|
|
@@ -2694,7 +2707,7 @@
|
|
|
2694
2707
|
"category": "dex-liquidity",
|
|
2695
2708
|
"description": "Remove liquidity from an open position and withdraw underlying tokens.",
|
|
2696
2709
|
"operationType": "write",
|
|
2697
|
-
"authRequired":
|
|
2710
|
+
"authRequired": false,
|
|
2698
2711
|
"parameters": [
|
|
2699
2712
|
{
|
|
2700
2713
|
"name": "ownerAddress",
|
|
@@ -2738,7 +2751,7 @@
|
|
|
2738
2751
|
"name": "fetchSwapPositionDirect",
|
|
2739
2752
|
"mcpTool": "gala_launchpad_fetch_swap_position_direct",
|
|
2740
2753
|
"category": "dex-liquidity",
|
|
2741
|
-
"description": "Fetch a single liquidity position using
|
|
2754
|
+
"description": "Fetch a single REST-backed liquidity position by compound key using token0, token1, fee, and tick range (~1s freshness; no signer required). Restricted tokens return TokenRestrictedError (403), a missing pool or position returns a not-found error, and heavy usage may return 429 rate limit.",
|
|
2742
2755
|
"operationType": "read",
|
|
2743
2756
|
"authRequired": false,
|
|
2744
2757
|
"parameters": [
|
|
@@ -2792,7 +2805,7 @@
|
|
|
2792
2805
|
"category": "dex-liquidity",
|
|
2793
2806
|
"description": "Collect accumulated trading fees from a liquidity position without modifying the position.",
|
|
2794
2807
|
"operationType": "read",
|
|
2795
|
-
"authRequired":
|
|
2808
|
+
"authRequired": false,
|
|
2796
2809
|
"parameters": [
|
|
2797
2810
|
{
|
|
2798
2811
|
"name": "ownerAddress",
|
|
@@ -3050,7 +3063,7 @@
|
|
|
3050
3063
|
"category": "balance",
|
|
3051
3064
|
"description": "Update user profile (fullName and profileImage). Returns success flag and updated profile data.",
|
|
3052
3065
|
"operationType": "write",
|
|
3053
|
-
"authRequired":
|
|
3066
|
+
"authRequired": false,
|
|
3054
3067
|
"parameters": [
|
|
3055
3068
|
{
|
|
3056
3069
|
"name": "fullName",
|
|
@@ -3108,7 +3121,7 @@
|
|
|
3108
3121
|
"category": "balance",
|
|
3109
3122
|
"description": "Fetch all tokens the authenticated user can manage (owned tokens + moderated tokens + overseer status).\n\nReturns a unified view of:\n- **ownedTokens**: Tokens created by this wallet (with live status, viewer count)\n- **moderatedTokens**: Tokens where user has a moderator role (MANAGER, TECHNICAL_PRODUCER, MODERATOR) with role and invite scope details\n- **isOverseer**: Whether user has platform-wide overseer access\n- **overseerSince**: When overseer status was granted (if applicable)\n\nUse this for building moderation dashboards or determining which tokens a user can access Studio for.",
|
|
3110
3123
|
"operationType": "read",
|
|
3111
|
-
"authRequired":
|
|
3124
|
+
"authRequired": false,
|
|
3112
3125
|
"parameters": [
|
|
3113
3126
|
{
|
|
3114
3127
|
"name": "cursor",
|
|
@@ -3131,7 +3144,7 @@
|
|
|
3131
3144
|
"category": "referrals",
|
|
3132
3145
|
"description": "Fetch the authenticated user's unique referral URL for sharing. The referral URL can be used to earn rewards when new users sign up through the link. Requires wallet configuration.",
|
|
3133
3146
|
"operationType": "read",
|
|
3134
|
-
"authRequired":
|
|
3147
|
+
"authRequired": false,
|
|
3135
3148
|
"parameters": [],
|
|
3136
3149
|
"topic": "referral-system"
|
|
3137
3150
|
},
|
|
@@ -3242,7 +3255,7 @@
|
|
|
3242
3255
|
"category": "creation",
|
|
3243
3256
|
"description": "Create a new token on the launchpad.\n\nWORKFLOW:\n1. checkTokenName() → Verify name is available\n2. checkTokenSymbol() → Verify symbol is available\n3. launchToken() → Create token with validated name/symbol\n4. getUrlByTokenName() → Get frontend URL for the new token\n\nREQUIREMENT: At least one social URL (websiteUrl, twitterUrl, or telegramUrl) is required.\n\nRETURNS: Transaction details including token name, symbol, creator address, and transaction ID.",
|
|
3244
3257
|
"operationType": "write",
|
|
3245
|
-
"authRequired":
|
|
3258
|
+
"authRequired": false,
|
|
3246
3259
|
"parameters": [
|
|
3247
3260
|
{
|
|
3248
3261
|
"name": "tokenName",
|
|
@@ -3331,7 +3344,7 @@
|
|
|
3331
3344
|
"category": "creation",
|
|
3332
3345
|
"description": "Upload token image from filesystem (Node.js only).",
|
|
3333
3346
|
"operationType": "read",
|
|
3334
|
-
"authRequired":
|
|
3347
|
+
"authRequired": false,
|
|
3335
3348
|
"parameters": [
|
|
3336
3349
|
{
|
|
3337
3350
|
"name": "tokenName",
|
|
@@ -3360,7 +3373,7 @@
|
|
|
3360
3373
|
"category": "creation",
|
|
3361
3374
|
"description": "Upload profile image from filesystem (Node.js only).",
|
|
3362
3375
|
"operationType": "read",
|
|
3363
|
-
"authRequired":
|
|
3376
|
+
"authRequired": false,
|
|
3364
3377
|
"parameters": [
|
|
3365
3378
|
{
|
|
3366
3379
|
"name": "imagePath",
|
|
@@ -3419,7 +3432,7 @@
|
|
|
3419
3432
|
"category": "nft",
|
|
3420
3433
|
"description": "Estimate the dynamic fee to mint NFTs via DryRun. Fee varies based on quantity and network conditions.",
|
|
3421
3434
|
"operationType": "read",
|
|
3422
|
-
"authRequired":
|
|
3435
|
+
"authRequired": false,
|
|
3423
3436
|
"parameters": [
|
|
3424
3437
|
{
|
|
3425
3438
|
"name": "collection",
|
|
@@ -3460,7 +3473,7 @@
|
|
|
3460
3473
|
"category": "nft",
|
|
3461
3474
|
"description": "Calculate total fees for multiple NFT operations. Returns breakdown with total.",
|
|
3462
3475
|
"operationType": "read",
|
|
3463
|
-
"authRequired":
|
|
3476
|
+
"authRequired": false,
|
|
3464
3477
|
"parameters": [
|
|
3465
3478
|
{
|
|
3466
3479
|
"name": "claimCollection",
|
|
@@ -3499,7 +3512,7 @@
|
|
|
3499
3512
|
"category": "nft",
|
|
3500
3513
|
"description": "Claim an NFT collection name. Costs 10,000 GALA.",
|
|
3501
3514
|
"operationType": "write",
|
|
3502
|
-
"authRequired":
|
|
3515
|
+
"authRequired": false,
|
|
3503
3516
|
"parameters": [
|
|
3504
3517
|
{
|
|
3505
3518
|
"name": "collectionName",
|
|
@@ -3533,7 +3546,7 @@
|
|
|
3533
3546
|
"category": "nft",
|
|
3534
3547
|
"description": "Create a token class within an NFT collection. Costs 1,000 GALA.",
|
|
3535
3548
|
"operationType": "write",
|
|
3536
|
-
"authRequired":
|
|
3549
|
+
"authRequired": false,
|
|
3537
3550
|
"parameters": [
|
|
3538
3551
|
{
|
|
3539
3552
|
"name": "collection",
|
|
@@ -3639,7 +3652,7 @@
|
|
|
3639
3652
|
"category": "nft",
|
|
3640
3653
|
"description": "Mint NFTs from a token class. Costs dynamic fee based on quantity.",
|
|
3641
3654
|
"operationType": "read",
|
|
3642
|
-
"authRequired":
|
|
3655
|
+
"authRequired": false,
|
|
3643
3656
|
"parameters": [
|
|
3644
3657
|
{
|
|
3645
3658
|
"name": "collection",
|
|
@@ -3709,7 +3722,7 @@
|
|
|
3709
3722
|
"category": "transfers",
|
|
3710
3723
|
"description": "Transfer GALA tokens via GalaChain.",
|
|
3711
3724
|
"operationType": "write",
|
|
3712
|
-
"authRequired":
|
|
3725
|
+
"authRequired": false,
|
|
3713
3726
|
"parameters": [
|
|
3714
3727
|
{
|
|
3715
3728
|
"name": "recipientAddress",
|
|
@@ -3744,7 +3757,7 @@
|
|
|
3744
3757
|
"category": "transfers",
|
|
3745
3758
|
"description": "Transfer launchpad tokens via GalaChain.",
|
|
3746
3759
|
"operationType": "write",
|
|
3747
|
-
"authRequired":
|
|
3760
|
+
"authRequired": false,
|
|
3748
3761
|
"parameters": [
|
|
3749
3762
|
{
|
|
3750
3763
|
"name": "to",
|
|
@@ -3785,7 +3798,7 @@
|
|
|
3785
3798
|
"category": "locks",
|
|
3786
3799
|
"description": "Lock one or more token types on GalaChain in a single transaction.\n\nLocked tokens cannot be transferred until unlocked by the lock authority.\nUseful for staking, escrow, vesting, or other hold scenarios.\n\nSupports batch locking of multiple token types for efficiency.",
|
|
3787
3800
|
"operationType": "write",
|
|
3788
|
-
"authRequired":
|
|
3801
|
+
"authRequired": false,
|
|
3789
3802
|
"parameters": [
|
|
3790
3803
|
{
|
|
3791
3804
|
"name": "tokens",
|
|
@@ -3814,7 +3827,7 @@
|
|
|
3814
3827
|
"category": "locks",
|
|
3815
3828
|
"description": "Unlock one or more previously locked token types on GalaChain in a single transaction.\n\nReleases token holds, making them available for transfer again.\nMust be called by the lock authority (the address that locked the tokens\nor was designated as lock authority during the lock operation).\n\nSupports batch unlocking of multiple token types for efficiency.",
|
|
3816
3829
|
"operationType": "write",
|
|
3817
|
-
"authRequired":
|
|
3830
|
+
"authRequired": false,
|
|
3818
3831
|
"parameters": [
|
|
3819
3832
|
{
|
|
3820
3833
|
"name": "tokens",
|
|
@@ -3843,7 +3856,7 @@
|
|
|
3843
3856
|
"category": "burns",
|
|
3844
3857
|
"description": "Permanently burn (destroy) one or more token types on GalaChain in a single transaction.\n\n**WARNING: THIS OPERATION IS IRREVERSIBLE!**\n\nOnce tokens are burned, they are permanently destroyed and cannot be recovered.\nThe burned tokens are removed from circulation, reducing total supply.\n\nSupports batch burning of multiple token types in a single transaction.",
|
|
3845
3858
|
"operationType": "write",
|
|
3846
|
-
"authRequired":
|
|
3859
|
+
"authRequired": false,
|
|
3847
3860
|
"parameters": [
|
|
3848
3861
|
{
|
|
3849
3862
|
"name": "tokens",
|
|
@@ -3872,7 +3885,7 @@
|
|
|
3872
3885
|
"category": "wallet",
|
|
3873
3886
|
"description": "Create a new wallet with a random private key. Returns wallet address and private key. ⚠️ SECURITY: Store the private key securely immediately — it cannot be retrieved again and grants full access to the wallet.",
|
|
3874
3887
|
"operationType": "write",
|
|
3875
|
-
"authRequired":
|
|
3888
|
+
"authRequired": false,
|
|
3876
3889
|
"parameters": [],
|
|
3877
3890
|
"topic": "multi-wallet"
|
|
3878
3891
|
},
|
|
@@ -3882,7 +3895,7 @@
|
|
|
3882
3895
|
"category": "wallet",
|
|
3883
3896
|
"description": "Create a new Solana wallet with a random keypair. Returns wallet address and private key (base58 format). ⚠️ SECURITY: Store the private key securely immediately — it cannot be retrieved again and grants full access to the wallet.",
|
|
3884
3897
|
"operationType": "write",
|
|
3885
|
-
"authRequired":
|
|
3898
|
+
"authRequired": false,
|
|
3886
3899
|
"parameters": [],
|
|
3887
3900
|
"topic": "multi-wallet"
|
|
3888
3901
|
},
|
|
@@ -3912,7 +3925,7 @@
|
|
|
3912
3925
|
"category": "wallet",
|
|
3913
3926
|
"description": "Derive public key from private key using secp256k1. Returns uncompressed (0x04..., 132 chars) and compressed (0x02/03..., 68 chars) formats.",
|
|
3914
3927
|
"operationType": "read",
|
|
3915
|
-
"authRequired":
|
|
3928
|
+
"authRequired": false,
|
|
3916
3929
|
"parameters": [
|
|
3917
3930
|
{
|
|
3918
3931
|
"name": "privateKey",
|
|
@@ -3929,7 +3942,7 @@
|
|
|
3929
3942
|
"category": "wallet",
|
|
3930
3943
|
"description": "Derive Ethereum address from private key. Returns both Ethereum (0x...) and GalaChain (eth|...) address formats.",
|
|
3931
3944
|
"operationType": "read",
|
|
3932
|
-
"authRequired":
|
|
3945
|
+
"authRequired": false,
|
|
3933
3946
|
"parameters": [
|
|
3934
3947
|
{
|
|
3935
3948
|
"name": "privateKey",
|
|
@@ -3971,7 +3984,7 @@
|
|
|
3971
3984
|
"name": "explainSdkUsage",
|
|
3972
3985
|
"mcpTool": "gala_launchpad_explain_sdk_usage",
|
|
3973
3986
|
"category": "utils",
|
|
3974
|
-
"description": "Get detailed SDK code examples for all 310 MCP tools (mapping to 273 SDK methods) organized into
|
|
3987
|
+
"description": "Get detailed SDK code examples for all 310 MCP tools (mapping to 273 SDK methods) organized into 65 composite workflow topics covering: buy-tokens, sell-tokens, pool-graduation, fetch-pools, balances, token-creation, token-status, dex-trading, gdex-stream, liquidity-positions, advanced-dex-analysis, price-history, token-details, token-distribution, profile-management, multi-wallet, transfers, locks, trading-analytics, utilities-and-helpers, utilities-system, error-handling, installation, local-calculations, spot-prices-smart-routing, event-subscriptions, mcp-to-sdk-mapping, DEX leaderboards, bridge-operations, dex-token-discovery, wrap-unwrap-operations, referral-system, account-management, session-auth, streaming, stream-chat, ban-management, api-key-management, moderator-invites, overseer-invites, content-flag-management, content-reactions, trade-history, token-ban-management, nft-collection-management, token-identification, graduation-detection, ai-moderation (AI content analysis - overseer only), weekly-challenge (weekly token competition leaderboard), platform-stats (platform-wide trading metrics), restricted-names (blocked token names list - overseer only), websocket-admin (real-time event broadcasting - admin/overseer), oembed (social media link preview metadata), messages (unified CHAT+COMMENT messages API), and holders (token holder distribution and whale analysis).",
|
|
3975
3988
|
"operationType": "read",
|
|
3976
3989
|
"authRequired": false,
|
|
3977
3990
|
"parameters": [
|
|
@@ -3992,6 +4005,7 @@
|
|
|
3992
4005
|
"transfers",
|
|
3993
4006
|
"locks",
|
|
3994
4007
|
"dex-trading",
|
|
4008
|
+
"gdex-stream",
|
|
3995
4009
|
"error-handling",
|
|
3996
4010
|
"installation",
|
|
3997
4011
|
"local-calculations",
|
|
@@ -4083,7 +4097,7 @@
|
|
|
4083
4097
|
"category": "utils",
|
|
4084
4098
|
"description": "Clear token caches. With tokenName: clears that launchpad token. Without tokenName: clears ALL caches (launchpad metadata + bridgeable tokens). Caches auto-warm from fetchPools/fetchBridgeableTokens calls.",
|
|
4085
4099
|
"operationType": "read",
|
|
4086
|
-
"authRequired":
|
|
4100
|
+
"authRequired": false,
|
|
4087
4101
|
"parameters": [
|
|
4088
4102
|
{
|
|
4089
4103
|
"name": "tokenName",
|
|
@@ -4110,7 +4124,7 @@
|
|
|
4110
4124
|
"category": "utils",
|
|
4111
4125
|
"description": "Check if wallet is configured in the SDK. Returns true if wallet is available for signing operations, false if in read-only mode.",
|
|
4112
4126
|
"operationType": "read",
|
|
4113
|
-
"authRequired":
|
|
4127
|
+
"authRequired": false,
|
|
4114
4128
|
"parameters": [],
|
|
4115
4129
|
"topic": "utilities-system"
|
|
4116
4130
|
},
|
|
@@ -4130,7 +4144,7 @@
|
|
|
4130
4144
|
"category": "utils",
|
|
4131
4145
|
"description": "Configure a wallet for signing operations. Takes a private key and sets it as the active wallet.",
|
|
4132
4146
|
"operationType": "write",
|
|
4133
|
-
"authRequired":
|
|
4147
|
+
"authRequired": false,
|
|
4134
4148
|
"parameters": [
|
|
4135
4149
|
{
|
|
4136
4150
|
"name": "privateKey",
|
|
@@ -4156,7 +4170,7 @@
|
|
|
4156
4170
|
"category": "utils",
|
|
4157
4171
|
"description": "Dynamically switch the MCP server to a different environment (production, development, or testing). Preserves wallet configuration when switching.",
|
|
4158
4172
|
"operationType": "read",
|
|
4159
|
-
"authRequired":
|
|
4173
|
+
"authRequired": false,
|
|
4160
4174
|
"parameters": [
|
|
4161
4175
|
{
|
|
4162
4176
|
"name": "environment",
|
|
@@ -4177,7 +4191,7 @@
|
|
|
4177
4191
|
"category": "utils",
|
|
4178
4192
|
"description": "Clean up SDK resources (HTTP interceptors, WebSocket connections). Call when done using the SDK to prevent memory leaks.",
|
|
4179
4193
|
"operationType": "read",
|
|
4180
|
-
"authRequired":
|
|
4194
|
+
"authRequired": false,
|
|
4181
4195
|
"parameters": [],
|
|
4182
4196
|
"topic": "utilities-and-helpers"
|
|
4183
4197
|
},
|
|
@@ -4270,7 +4284,7 @@
|
|
|
4270
4284
|
"category": "bridge",
|
|
4271
4285
|
"description": "Estimate bridge fees for transferring tokens between GalaChain and an external chain. Returns fee amount in source token. Amount parameter is optional but recommended for accurate estimates.",
|
|
4272
4286
|
"operationType": "read",
|
|
4273
|
-
"authRequired":
|
|
4287
|
+
"authRequired": false,
|
|
4274
4288
|
"parameters": [
|
|
4275
4289
|
{
|
|
4276
4290
|
"name": "tokenId",
|
|
@@ -4303,7 +4317,7 @@
|
|
|
4303
4317
|
"category": "bridge",
|
|
4304
4318
|
"description": "Bridge tokens from GalaChain to an external chain (Ethereum or Solana). Requires wallet configuration.",
|
|
4305
4319
|
"operationType": "write",
|
|
4306
|
-
"authRequired":
|
|
4320
|
+
"authRequired": false,
|
|
4307
4321
|
"parameters": [
|
|
4308
4322
|
{
|
|
4309
4323
|
"name": "tokenId",
|
|
@@ -4342,7 +4356,7 @@
|
|
|
4342
4356
|
"category": "bridge",
|
|
4343
4357
|
"description": "Bridge tokens from an external chain (Ethereum or Solana) to GalaChain. Requires wallet configuration.",
|
|
4344
4358
|
"operationType": "write",
|
|
4345
|
-
"authRequired":
|
|
4359
|
+
"authRequired": false,
|
|
4346
4360
|
"parameters": [
|
|
4347
4361
|
{
|
|
4348
4362
|
"name": "tokenId",
|
|
@@ -4672,7 +4686,7 @@
|
|
|
4672
4686
|
"category": "bridge",
|
|
4673
4687
|
"description": "Request SOL airdrop from Solana devnet faucet. Only available in STAGE environment (development/testing). Maximum 2 SOL per request. Useful for funding wallets with gas fees for testing bridge operations.",
|
|
4674
4688
|
"operationType": "read",
|
|
4675
|
-
"authRequired":
|
|
4689
|
+
"authRequired": false,
|
|
4676
4690
|
"parameters": [
|
|
4677
4691
|
{
|
|
4678
4692
|
"name": "amount",
|
|
@@ -4813,7 +4827,7 @@
|
|
|
4813
4827
|
"category": "bridge",
|
|
4814
4828
|
"description": "Wrap a token to its asset-channel counterpart (e.g., MUSIC → GMUSIC). This is a cross-channel bridge within GalaChain, NOT an external bridge to Ethereum/Solana. Requires wallet configuration. Use for tokens that need to be wrapped before DEX trading.",
|
|
4815
4829
|
"operationType": "write",
|
|
4816
|
-
"authRequired":
|
|
4830
|
+
"authRequired": false,
|
|
4817
4831
|
"parameters": [
|
|
4818
4832
|
{
|
|
4819
4833
|
"name": "tokenId",
|
|
@@ -4848,7 +4862,7 @@
|
|
|
4848
4862
|
"category": "bridge",
|
|
4849
4863
|
"description": "Unwrap a token back to its native channel (e.g., GMUSIC → MUSIC). Reverses a previous wrap operation. This is a cross-channel bridge within GalaChain, NOT an external bridge. Requires wallet configuration.",
|
|
4850
4864
|
"operationType": "write",
|
|
4851
|
-
"authRequired":
|
|
4865
|
+
"authRequired": false,
|
|
4852
4866
|
"parameters": [
|
|
4853
4867
|
{
|
|
4854
4868
|
"name": "tokenId",
|
|
@@ -4883,7 +4897,7 @@
|
|
|
4883
4897
|
"category": "bridge",
|
|
4884
4898
|
"description": "Estimate fees for wrapping a token to the asset channel. Wrap operations use cross_channel_authorization fee type on the source channel.",
|
|
4885
4899
|
"operationType": "read",
|
|
4886
|
-
"authRequired":
|
|
4900
|
+
"authRequired": false,
|
|
4887
4901
|
"parameters": [
|
|
4888
4902
|
{
|
|
4889
4903
|
"name": "tokenId",
|
|
@@ -4906,7 +4920,7 @@
|
|
|
4906
4920
|
"category": "bridge",
|
|
4907
4921
|
"description": "Estimate fees for unwrapping a token back to its native channel. Unwrap operations use automatic fee authorization on the asset channel.",
|
|
4908
4922
|
"operationType": "read",
|
|
4909
|
-
"authRequired":
|
|
4923
|
+
"authRequired": false,
|
|
4910
4924
|
"parameters": [
|
|
4911
4925
|
{
|
|
4912
4926
|
"name": "tokenId",
|
|
@@ -4946,7 +4960,7 @@
|
|
|
4946
4960
|
"category": "streaming",
|
|
4947
4961
|
"description": "Start a live stream for a token.\n\nCreates a new stream session and returns streaming credentials.\nrtmpsUrl is the full RTMPS ingest URL; srtUrl is the full SRT ingest URL.\nUse streamKey + srtPassphrase for manual encoder configuration.\n\nRETURNS: { tokenName, streamKey, rtmpsUrl, srtUrl, srtPassphrase, playbackId, playbackUrl, status, createdAt }\n\nAuthentication: Requires wallet signature (stream creator only)",
|
|
4948
4962
|
"operationType": "write",
|
|
4949
|
-
"authRequired":
|
|
4963
|
+
"authRequired": false,
|
|
4950
4964
|
"parameters": [
|
|
4951
4965
|
{
|
|
4952
4966
|
"name": "tokenName",
|
|
@@ -4963,7 +4977,7 @@
|
|
|
4963
4977
|
"category": "streaming",
|
|
4964
4978
|
"description": "Stop a live stream for a token.\n\nEnds the current stream session. The stream key remains valid for future streams.\n\nRETURNS: { success: true }\n\nAuthentication: Requires wallet signature (stream creator only)",
|
|
4965
4979
|
"operationType": "write",
|
|
4966
|
-
"authRequired":
|
|
4980
|
+
"authRequired": false,
|
|
4967
4981
|
"parameters": [
|
|
4968
4982
|
{
|
|
4969
4983
|
"name": "tokenName",
|
|
@@ -4980,7 +4994,7 @@
|
|
|
4980
4994
|
"category": "streaming",
|
|
4981
4995
|
"description": "Enable or disable streaming for a specific token (Admin only).\n\nControls per-token streaming capability. When disabled, prevents new streams\nfrom being started for this token. Existing active streams will continue\nuntil they end.\n\nRETURNS: { enabled, tokenName }\n\nAuthentication: Requires streamAdminApiKey configuration",
|
|
4982
4996
|
"operationType": "write",
|
|
4983
|
-
"authRequired":
|
|
4997
|
+
"authRequired": false,
|
|
4984
4998
|
"parameters": [
|
|
4985
4999
|
{
|
|
4986
5000
|
"name": "tokenName",
|
|
@@ -5002,7 +5016,7 @@
|
|
|
5002
5016
|
"category": "streaming",
|
|
5003
5017
|
"description": "Reset the stream key for a token.\n\nGenerates a new stream key, invalidating the previous one.\nUse this if the stream key has been compromised.\n\nRETURNS: { tokenName, streamKey, rtmpsUrl, srtUrl, srtPassphrase, playbackId, resetAt }\n\nAuthentication: Requires wallet signature (stream creator only)",
|
|
5004
5018
|
"operationType": "write",
|
|
5005
|
-
"authRequired":
|
|
5019
|
+
"authRequired": false,
|
|
5006
5020
|
"parameters": [
|
|
5007
5021
|
{
|
|
5008
5022
|
"name": "tokenName",
|
|
@@ -5019,7 +5033,7 @@
|
|
|
5019
5033
|
"category": "streaming",
|
|
5020
5034
|
"description": "Set the next live stream countdown time for a token.\n\nSchedules a future live stream for this token. The countdown can be displayed on the pool page\nto let viewers know when the stream will go live.\n\nCan be called multiple times to update the scheduled time.\nPass null as nextLiveStreamAt to clear the countdown.\n\nRETURNS: { success: true, message: \"...\" }\n\nAuthentication: Requires wallet signature (stream creator only)",
|
|
5021
5035
|
"operationType": "write",
|
|
5022
|
-
"authRequired":
|
|
5036
|
+
"authRequired": false,
|
|
5023
5037
|
"parameters": [
|
|
5024
5038
|
{
|
|
5025
5039
|
"name": "tokenName",
|
|
@@ -5051,7 +5065,7 @@
|
|
|
5051
5065
|
"category": "streaming",
|
|
5052
5066
|
"description": "Enable or disable streaming globally (Admin only).\n\nControls platform-wide streaming capability.\nWhen disabled, no new streams can be started.\n\nRETURNS: { enabled, updatedAt }\n\nAuthentication: Requires streamAdminApiKey configuration",
|
|
5053
5067
|
"operationType": "write",
|
|
5054
|
-
"authRequired":
|
|
5068
|
+
"authRequired": false,
|
|
5055
5069
|
"parameters": [
|
|
5056
5070
|
{
|
|
5057
5071
|
"name": "enabled",
|
|
@@ -5068,7 +5082,7 @@
|
|
|
5068
5082
|
"category": "streaming",
|
|
5069
5083
|
"description": "Get the authenticated user's role for a token's stream with associated permissions.\n\nReturns effective role (OWNER, MANAGER, TECHNICAL_PRODUCER, MODERATOR) with boolean permission flags.\ncanStream: Can start/stop streams. canModerate: Can moderate chat/ban. canManageTeam: Can manage moderator invites.\n\nRETURNS: { role: 'OWNER'|'MANAGER'|'TECHNICAL_PRODUCER'|'MODERATOR'|null, isOwner, permissions: { canStream, canModerate, canManageTeam, canViewRecordings, canSimulcast }, source, inviteScope }\n\nAuthentication: Optional JWT - returns limited data if not authenticated",
|
|
5070
5084
|
"operationType": "read",
|
|
5071
|
-
"authRequired":
|
|
5085
|
+
"authRequired": false,
|
|
5072
5086
|
"parameters": [
|
|
5073
5087
|
{
|
|
5074
5088
|
"name": "tokenName",
|
|
@@ -5095,7 +5109,7 @@
|
|
|
5095
5109
|
"category": "streaming",
|
|
5096
5110
|
"description": "Check if the authenticated user has Studio access for a token.\n\nReturns comprehensive access information combining:\n1. Token ownership check (OWNER role)\n2. Claimed moderator invite (MANAGER, TECHNICAL_PRODUCER, MODERATOR)\n3. Platform overseer status (global access)\n\nThis is used by frontends to determine whether to show \"Click to Studio\" links.\n\n**Access Sources:**\n- ownership: User is the token owner (OWNER role)\n- moderator_invite: User has a claimed moderator invite\n- overseer: User has platform-wide overseer access\n\n**Permissions Returned:**\n- canStream: Can start/stop streams\n- canModerate: Can moderate chat and ban users\n- canManageTeam: Can manage moderator invites\n- canViewRecordings: Can view and download recordings\n- canSimulcast: Can manage simulcast targets\n- canViewAnalytics: Can view stream analytics\n\nRETURNS: {\n hasAccess: boolean,\n role: 'OWNER' | 'MANAGER' | 'TECHNICAL_PRODUCER' | 'MODERATOR' | 'OVERSEER' | null,\n permissions: { canStream, canModerate, canManageTeam, canViewRecordings, canSimulcast, canViewAnalytics },\n accessSource: 'ownership' | 'moderator_invite' | 'overseer' | null,\n inviteScope?: 'TOKEN' | 'ALL_OWNER_TOKENS' | null,\n isOwner: boolean,\n isOverseer: boolean\n}\n\nAuthentication: Optional JWT - returns limited data if not authenticated",
|
|
5097
5111
|
"operationType": "read",
|
|
5098
|
-
"authRequired":
|
|
5112
|
+
"authRequired": false,
|
|
5099
5113
|
"parameters": [
|
|
5100
5114
|
{
|
|
5101
5115
|
"name": "tokenName",
|
|
@@ -5164,7 +5178,7 @@
|
|
|
5164
5178
|
"category": "recordings",
|
|
5165
5179
|
"description": "Delete a stream recording.\n\nPermanently removes the recording. This action cannot be undone.\n\nRETURNS: { success: true }\n\nAuthentication: Requires wallet signature (stream creator only)",
|
|
5166
5180
|
"operationType": "write",
|
|
5167
|
-
"authRequired":
|
|
5181
|
+
"authRequired": false,
|
|
5168
5182
|
"parameters": [
|
|
5169
5183
|
{
|
|
5170
5184
|
"name": "tokenName",
|
|
@@ -5204,7 +5218,7 @@
|
|
|
5204
5218
|
"category": "simulcasts",
|
|
5205
5219
|
"description": "Add a simulcast target to a stream.\n\nConfigure the stream to rebroadcast to an external platform like YouTube, Twitch, or Facebook.\n\nRETURNS: { target: { targetId, platform, rtmpUrl, status, name, createdAt }, tokenName }\n\nAuthentication: Requires wallet signature (stream creator only)",
|
|
5206
5220
|
"operationType": "write",
|
|
5207
|
-
"authRequired":
|
|
5221
|
+
"authRequired": false,
|
|
5208
5222
|
"parameters": [
|
|
5209
5223
|
{
|
|
5210
5224
|
"name": "tokenName",
|
|
@@ -5251,7 +5265,7 @@
|
|
|
5251
5265
|
"category": "simulcasts",
|
|
5252
5266
|
"description": "Remove a simulcast target from a stream.\n\nStops rebroadcasting to the specified platform.\n\nRETURNS: { success: true }\n\nAuthentication: Requires wallet signature (stream creator only)",
|
|
5253
5267
|
"operationType": "write",
|
|
5254
|
-
"authRequired":
|
|
5268
|
+
"authRequired": false,
|
|
5255
5269
|
"parameters": [
|
|
5256
5270
|
{
|
|
5257
5271
|
"name": "tokenName",
|
|
@@ -5291,7 +5305,7 @@
|
|
|
5291
5305
|
"category": "chat",
|
|
5292
5306
|
"description": "Enable or disable chat for a specific token.\n\nDual-auth endpoint - supports both Admin API key and JWT (owner) auth.\n\n**Authorization:**\n- Admin (API key): Sets ADMIN_DISABLED when disabling - owner is locked out\n- Owner (JWT): Sets DISABLED when disabling - owner can re-enable later\n\nWhen ADMIN_DISABLED, only an admin can enable chat.\nOwners attempting to enable when ADMIN_DISABLED will get a 403 error.\n\nRETURNS: { enabled, tokenName, status }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth (token owner)",
|
|
5293
5307
|
"operationType": "write",
|
|
5294
|
-
"authRequired":
|
|
5308
|
+
"authRequired": false,
|
|
5295
5309
|
"parameters": [
|
|
5296
5310
|
{
|
|
5297
5311
|
"name": "tokenName",
|
|
@@ -5313,7 +5327,7 @@
|
|
|
5313
5327
|
"category": "chat",
|
|
5314
5328
|
"description": "Set slow mode interval for a stream chat.\n\nSlow mode throttles users to one message per N seconds.\nEnforcement is server-side (Redis-backed rate limiting).\nSetting to 0 disables slow mode.\n\nValid presets: 0 (off), 10, 30, 60, 300 seconds.\nMaximum: 600 seconds (10 minutes).\n\nRETURNS: { tokenName, slowModeSeconds }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth (token owner/moderator)",
|
|
5315
5329
|
"operationType": "write",
|
|
5316
|
-
"authRequired":
|
|
5330
|
+
"authRequired": false,
|
|
5317
5331
|
"parameters": [
|
|
5318
5332
|
{
|
|
5319
5333
|
"name": "tokenName",
|
|
@@ -5345,7 +5359,7 @@
|
|
|
5345
5359
|
"category": "chat",
|
|
5346
5360
|
"description": "Enable or disable chat globally (Admin only).\n\nControls platform-wide chat capability.\nWhen disabled, no chat messages can be sent.\n\nRETURNS: { enabled, updatedAt }\n\nAuthentication: Requires streamAdminApiKey configuration",
|
|
5347
5361
|
"operationType": "write",
|
|
5348
|
-
"authRequired":
|
|
5362
|
+
"authRequired": false,
|
|
5349
5363
|
"parameters": [
|
|
5350
5364
|
{
|
|
5351
5365
|
"name": "enabled",
|
|
@@ -5388,7 +5402,7 @@
|
|
|
5388
5402
|
"category": "chat",
|
|
5389
5403
|
"description": "Subscribe to a stream's real-time events.\n\nMust be connected via gala_launchpad_connect_stream_websocket first - throws error if not connected.\nAfter subscribing, you will receive these events:\n- stream_status: Live/offline status changes\n- viewer_count: Real-time viewer count updates\n- chat_message: New chat messages\n- chat_status: Chat enable/disable events\n\nRETURNS: { tokenName, status, playbackId, isLive, subscribedAt }",
|
|
5390
5404
|
"operationType": "read",
|
|
5391
|
-
"authRequired":
|
|
5405
|
+
"authRequired": false,
|
|
5392
5406
|
"parameters": [
|
|
5393
5407
|
{
|
|
5394
5408
|
"name": "tokenName",
|
|
@@ -5479,7 +5493,7 @@
|
|
|
5479
5493
|
"category": "auth",
|
|
5480
5494
|
"description": "Authenticate with wallet signature to get JWT token. Required before using protected features (streaming, chat, uploads). Returns expiresIn seconds; the token is managed internally and never returned via MCP.",
|
|
5481
5495
|
"operationType": "read",
|
|
5482
|
-
"authRequired":
|
|
5496
|
+
"authRequired": false,
|
|
5483
5497
|
"parameters": [],
|
|
5484
5498
|
"topic": "session-auth"
|
|
5485
5499
|
},
|
|
@@ -5489,7 +5503,7 @@
|
|
|
5489
5503
|
"category": "auth",
|
|
5490
5504
|
"description": "Clear JWT token and end session. Future protected operations will fail until login() is called again.",
|
|
5491
5505
|
"operationType": "read",
|
|
5492
|
-
"authRequired":
|
|
5506
|
+
"authRequired": false,
|
|
5493
5507
|
"parameters": [],
|
|
5494
5508
|
"topic": "session-auth"
|
|
5495
5509
|
},
|
|
@@ -5499,7 +5513,7 @@
|
|
|
5499
5513
|
"category": "auth",
|
|
5500
5514
|
"description": "Refresh JWT token before it expires. Use shouldRefreshToken() to check if refresh is needed. Returns expiresIn seconds; the token is managed internally and never returned via MCP.",
|
|
5501
5515
|
"operationType": "read",
|
|
5502
|
-
"authRequired":
|
|
5516
|
+
"authRequired": false,
|
|
5503
5517
|
"parameters": [],
|
|
5504
5518
|
"topic": "session-auth"
|
|
5505
5519
|
},
|
|
@@ -5509,7 +5523,7 @@
|
|
|
5509
5523
|
"category": "auth",
|
|
5510
5524
|
"description": "Get current session information from backend. Returns authenticated address and token timestamps. Requires active session.",
|
|
5511
5525
|
"operationType": "read",
|
|
5512
|
-
"authRequired":
|
|
5526
|
+
"authRequired": false,
|
|
5513
5527
|
"parameters": [],
|
|
5514
5528
|
"topic": "session-auth"
|
|
5515
5529
|
},
|
|
@@ -5529,7 +5543,7 @@
|
|
|
5529
5543
|
"category": "auth",
|
|
5530
5544
|
"description": "Check if JWT token should be refreshed (expires within threshold). Default threshold is 5 minutes. Returns boolean.",
|
|
5531
5545
|
"operationType": "read",
|
|
5532
|
-
"authRequired":
|
|
5546
|
+
"authRequired": false,
|
|
5533
5547
|
"parameters": [
|
|
5534
5548
|
{
|
|
5535
5549
|
"name": "thresholdMs",
|
|
@@ -5556,7 +5570,7 @@
|
|
|
5556
5570
|
"category": "auth",
|
|
5557
5571
|
"description": "Ensure valid token exists, refreshing if necessary. Call before long operations. Throws if not authenticated.",
|
|
5558
5572
|
"operationType": "read",
|
|
5559
|
-
"authRequired":
|
|
5573
|
+
"authRequired": false,
|
|
5560
5574
|
"parameters": [
|
|
5561
5575
|
{
|
|
5562
5576
|
"name": "thresholdMs",
|
|
@@ -5573,7 +5587,7 @@
|
|
|
5573
5587
|
"category": "ban",
|
|
5574
5588
|
"description": "Create a ban for a user on a token.\n\nBans prevent users from sending chat messages and reactions on the specified token's stream.\nCan be permanent (omit durationSeconds) or temporary (specify duration).\n\n**Duration Presets:**\n- 1 hour: 3600\n- 1 day: 86400\n- 1 week: 604800\n- 1 month: 2592000\n\nRETURNS: { ban: { id, userAddress, tokenName, reason, bannedBy, expiresAt, createdAt, isPermanent }, tokenName }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth (token owner).",
|
|
5575
5589
|
"operationType": "write",
|
|
5576
|
-
"authRequired":
|
|
5590
|
+
"authRequired": false,
|
|
5577
5591
|
"parameters": [
|
|
5578
5592
|
{
|
|
5579
5593
|
"name": "tokenName",
|
|
@@ -5608,7 +5622,7 @@
|
|
|
5608
5622
|
"category": "ban",
|
|
5609
5623
|
"description": "Remove a ban for a user on a token.\n\nUnbans the user, allowing them to send chat messages and reactions again.\n\nRETURNS: { removed: true, tokenName, userAddress }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth (token owner).",
|
|
5610
5624
|
"operationType": "write",
|
|
5611
|
-
"authRequired":
|
|
5625
|
+
"authRequired": false,
|
|
5612
5626
|
"parameters": [
|
|
5613
5627
|
{
|
|
5614
5628
|
"name": "tokenName",
|
|
@@ -5678,7 +5692,7 @@
|
|
|
5678
5692
|
"category": "ban",
|
|
5679
5693
|
"description": "Check if a specific user is banned on a token.\n\nReturns whether the user is currently banned and ban details if applicable.\n\nRETURNS: { banned: boolean, ban?: { ... }, tokenName, userAddress }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth (token owner).",
|
|
5680
5694
|
"operationType": "read",
|
|
5681
|
-
"authRequired":
|
|
5695
|
+
"authRequired": false,
|
|
5682
5696
|
"parameters": [
|
|
5683
5697
|
{
|
|
5684
5698
|
"name": "tokenName",
|
|
@@ -5746,7 +5760,7 @@
|
|
|
5746
5760
|
"category": "ban",
|
|
5747
5761
|
"description": "Watch for user ban enforcement events in real-time.\n\nTriggers when users are banned, unbanned, or ban enforcement actions are taken. Includes:\n- USER_BANNED: User restricted from platform due to policy violation\n- USER_UNBANNED: Ban lifted, user access restored\n- BAN_ENFORCEMENT: Enforcement action taken (message deletion, chat suspension, etc.)\n\nReturns:\n- banActionsEnforced: Number of ban enforcement events detected\n- events: Array of ban events with userAddress, actionType, reason, tokenName, and timestamp\n\nFilter Options:\n- userAddress: Only watch bans for a specific user\n- actionType: Filter by action type ('BANNED', 'UNBANNED', or 'ENFORCEMENT')\n- tokenName: Only watch bans related to a specific token\n- reason: Filter by ban reason or violation type.",
|
|
5748
5762
|
"operationType": "read",
|
|
5749
|
-
"authRequired":
|
|
5763
|
+
"authRequired": false,
|
|
5750
5764
|
"parameters": [
|
|
5751
5765
|
{
|
|
5752
5766
|
"name": "userAddress",
|
|
@@ -5798,7 +5812,7 @@
|
|
|
5798
5812
|
"category": "api-keys",
|
|
5799
5813
|
"description": "Create a new API key for delegating permissions.\n\n**CRITICAL**: The rawKey in the response is ONLY shown once!\nStore it securely immediately - it cannot be retrieved again.\n\n**Roles (hierarchical):**\n- MODERATOR: Manage comments, chat, bans\n- TECHNICAL_PRODUCER: Stream control, simulcast\n- MANAGER: Moderator + Technical Producer + recordings\n- OWNER: Full access\n\n**Token Delegation:**\n- delegateAllTokens=true: Access to all current and future tokens\n- delegateAllTokens=false + tokenNames: Access to specific tokens only\n\nRETURNS: { id, keyPrefix, rawKey, description, role, delegateAllTokens, tokenNames, expiresAt, createdAt, ... }\n\nAuthentication: Requires JWT auth (call sdk.login() first).",
|
|
5800
5814
|
"operationType": "write",
|
|
5801
|
-
"authRequired":
|
|
5815
|
+
"authRequired": false,
|
|
5802
5816
|
"parameters": [
|
|
5803
5817
|
{
|
|
5804
5818
|
"name": "role",
|
|
@@ -5845,7 +5859,7 @@
|
|
|
5845
5859
|
"category": "api-keys",
|
|
5846
5860
|
"description": "List all API keys for the authenticated user.\n\nReturns a paginated list of API keys using cursor-based pagination.\nRaw keys are never included - they are only shown once at creation time.\n\nRETURNS: { apiKeys: [...], pageInfo: { hasNextPage, endCursor, hasPreviousPage, startCursor } }\n\nAuthentication: Requires JWT auth (call sdk.login() first).",
|
|
5847
5861
|
"operationType": "read",
|
|
5848
|
-
"authRequired":
|
|
5862
|
+
"authRequired": false,
|
|
5849
5863
|
"parameters": [
|
|
5850
5864
|
{
|
|
5851
5865
|
"name": "cursor",
|
|
@@ -5868,7 +5882,7 @@
|
|
|
5868
5882
|
"category": "api-keys",
|
|
5869
5883
|
"description": "Get a single API key by ID.\n\nReturns the API key metadata. Raw key is never included.\n\nRETURNS: { id, keyPrefix, description, role, delegateAllTokens, tokenNames, expiresAt, lastUsedAt, createdAt, updatedAt }\n\nAuthentication: Requires JWT auth (call sdk.login() first).",
|
|
5870
5884
|
"operationType": "read",
|
|
5871
|
-
"authRequired":
|
|
5885
|
+
"authRequired": false,
|
|
5872
5886
|
"parameters": [
|
|
5873
5887
|
{
|
|
5874
5888
|
"name": "id",
|
|
@@ -5885,7 +5899,7 @@
|
|
|
5885
5899
|
"category": "api-keys",
|
|
5886
5900
|
"description": "Update an API key's metadata and permissions.\n\nCannot change the key itself, only metadata and permissions.\nAt least one field must be provided.\n\n**Updatable fields:**\n- role: Change permission level\n- description: Update label/description\n- delegateAllTokens: Toggle all-token access\n- tokenNames: Update specific token delegations (replaces existing)\n- expiresAt: Update expiration (null to remove)\n\nRETURNS: { id, keyPrefix, description, role, delegateAllTokens, tokenNames, expiresAt, lastUsedAt, createdAt, updatedAt }\n\nAuthentication: Requires JWT auth (call sdk.login() first).",
|
|
5887
5901
|
"operationType": "write",
|
|
5888
|
-
"authRequired":
|
|
5902
|
+
"authRequired": false,
|
|
5889
5903
|
"parameters": [
|
|
5890
5904
|
{
|
|
5891
5905
|
"name": "id",
|
|
@@ -5938,7 +5952,7 @@
|
|
|
5938
5952
|
"category": "api-keys",
|
|
5939
5953
|
"description": "Revoke an API key.\n\nThis performs a soft delete - the key becomes immediately unusable\nbut is retained for audit purposes.\n\nRETURNS: { success: true, message: \"API key revoked\" }\n\nAuthentication: Requires JWT auth (call sdk.login() first).",
|
|
5940
5954
|
"operationType": "write",
|
|
5941
|
-
"authRequired":
|
|
5955
|
+
"authRequired": false,
|
|
5942
5956
|
"parameters": [
|
|
5943
5957
|
{
|
|
5944
5958
|
"name": "id",
|
|
@@ -5955,7 +5969,7 @@
|
|
|
5955
5969
|
"category": "api-keys",
|
|
5956
5970
|
"description": "Get all valid API key roles.\n\nReturns the list of available roles for API keys.\nUseful for understanding the permission hierarchy.\n\n**Roles (hierarchical):**\n- MODERATOR: Manage comments, chat messages, ban/unban users\n- TECHNICAL_PRODUCER: Simulcast targets, stream key, stop/start stream\n- MANAGER: Moderator + Technical Producer + recordings + stream settings\n- OWNER: Full access (indistinguishable from normal auth)\n\nRETURNS: { roles: [\"MODERATOR\", \"TECHNICAL_PRODUCER\", \"MANAGER\", \"OWNER\"] }\n\nAuthentication: None required (utility method).",
|
|
5957
5971
|
"operationType": "read",
|
|
5958
|
-
"authRequired":
|
|
5972
|
+
"authRequired": false,
|
|
5959
5973
|
"parameters": [],
|
|
5960
5974
|
"topic": "api-key-management"
|
|
5961
5975
|
},
|
|
@@ -5965,7 +5979,7 @@
|
|
|
5965
5979
|
"category": "moderators",
|
|
5966
5980
|
"description": "Create a moderator invite for a token or all tokens.\n\nCreates a magic link invite that can be shared to grant moderator access.\nThe recipient claims the invite after logging in.\n\n**Invite Scopes:**\n- TOKEN (default): Access to a specific token only. tokenName is required.\n- ALL_OWNER_TOKENS: Blanket access to ALL tokens owned by the inviter.\n The moderator gains access to current AND future tokens. Omit tokenName.\n\n**Roles:**\n- MODERATOR: Manage comments, chat, bans\n- TECHNICAL_PRODUCER: Stream control, simulcast, stream key\n- MANAGER: All of the above + recordings + stream settings\n\n**Note:** OWNER role is not available for invites.\n\nRETURNS: { invite: { id, inviteScope, tokenName, role, inviteCode, inviteUrl, description, status, expiresAt, createdAt } }\n\nAuthentication: Requires JWT auth as token owner.",
|
|
5967
5981
|
"operationType": "write",
|
|
5968
|
-
"authRequired":
|
|
5982
|
+
"authRequired": false,
|
|
5969
5983
|
"parameters": [
|
|
5970
5984
|
{
|
|
5971
5985
|
"name": "inviteScope",
|
|
@@ -6015,7 +6029,7 @@
|
|
|
6015
6029
|
"category": "moderators",
|
|
6016
6030
|
"description": "Claim a moderator invite.\n\nClaims an invite using the code from a magic link URL. The authenticated\nuser's wallet becomes the moderator with the granted role.\n\n**Requirements:**\n- Invite must be in PENDING status\n- Invite must not be expired\n\n**Returns based on invite scope:**\n- TOKEN scope: { token: { tokenName, tokenSymbol, role, inviteScope, ... } }\n- ALL_OWNER_TOKENS scope: { blanketAccess: { inviteScope, role, claimedAt } }\n\nAuthentication: Requires JWT auth.",
|
|
6017
6031
|
"operationType": "write",
|
|
6018
|
-
"authRequired":
|
|
6032
|
+
"authRequired": false,
|
|
6019
6033
|
"parameters": [
|
|
6020
6034
|
{
|
|
6021
6035
|
"name": "inviteCode",
|
|
@@ -6032,7 +6046,7 @@
|
|
|
6032
6046
|
"category": "moderators",
|
|
6033
6047
|
"description": "Get all tokens the current user moderates.\n\nReturns a paginated list of tokens where the authenticated user has claimed\na moderator invite and has active access using cursor-based pagination.\nUsed for the /studio dashboard.\n\nRETURNS: { tokens: [...], pageInfo: { hasNextPage, endCursor, hasPreviousPage, startCursor } }\n\nAuthentication: Requires JWT auth.",
|
|
6034
6048
|
"operationType": "read",
|
|
6035
|
-
"authRequired":
|
|
6049
|
+
"authRequired": false,
|
|
6036
6050
|
"parameters": [
|
|
6037
6051
|
{
|
|
6038
6052
|
"name": "cursor",
|
|
@@ -6055,7 +6069,7 @@
|
|
|
6055
6069
|
"category": "moderators",
|
|
6056
6070
|
"description": "List moderator invites.\n\nReturns a paginated list of moderator invites using cursor-based pagination.\nBehavior depends on tokenName:\n- With tokenName: Returns invites for that specific token (verifies ownership)\n- Without tokenName: Returns ALL invites created by the authenticated user across all tokens\n\nRETURNS: { invites: [...], pageInfo: { hasNextPage, endCursor, hasPreviousPage, startCursor } }\n\nAuthentication: Requires JWT auth.",
|
|
6057
6071
|
"operationType": "read",
|
|
6058
|
-
"authRequired":
|
|
6072
|
+
"authRequired": false,
|
|
6059
6073
|
"parameters": [
|
|
6060
6074
|
{
|
|
6061
6075
|
"name": "tokenName",
|
|
@@ -6096,7 +6110,7 @@
|
|
|
6096
6110
|
"category": "moderators",
|
|
6097
6111
|
"description": "Revoke a moderator invite.\n\nRevokes an invite by ID, preventing it from being claimed. If already claimed,\nthe moderator loses access to the token.\n\nRETURNS: { success: true, message: \"Invite revoked\" }\n\nAuthentication: Requires JWT auth as token owner.",
|
|
6098
6112
|
"operationType": "write",
|
|
6099
|
-
"authRequired":
|
|
6113
|
+
"authRequired": false,
|
|
6100
6114
|
"parameters": [
|
|
6101
6115
|
{
|
|
6102
6116
|
"name": "inviteId",
|
|
@@ -6113,7 +6127,7 @@
|
|
|
6113
6127
|
"category": "moderators",
|
|
6114
6128
|
"description": "Update the role of a moderator invite.\n\nChanges the role granted by the invite. For claimed invites, the moderator's\neffective permissions change immediately (enforced at runtime).\n\n**Roles:**\n- MODERATOR: Manage comments, chat, bans\n- TECHNICAL_PRODUCER: Stream control, simulcast, stream key\n- MANAGER: All of the above + recordings + stream settings\n\n**Note:** OWNER role is not available for invites.\n\nRETURNS: { invite: { id, inviteScope, tokenName, role, inviteCode, inviteUrl, description, status, expiresAt, createdAt } }\n\nAuthentication: Requires JWT auth as token owner.",
|
|
6115
6129
|
"operationType": "write",
|
|
6116
|
-
"authRequired":
|
|
6130
|
+
"authRequired": false,
|
|
6117
6131
|
"parameters": [
|
|
6118
6132
|
{
|
|
6119
6133
|
"name": "inviteId",
|
|
@@ -6141,7 +6155,7 @@
|
|
|
6141
6155
|
"category": "moderators",
|
|
6142
6156
|
"description": "Update a moderator invite's role and/or description.\n\nUpdates an existing moderator invite. At least one of role or description must be provided.\nCan update role, description, or both in a single call.\n\n**Roles:**\n- MODERATOR: Manage comments, chat, bans\n- TECHNICAL_PRODUCER: Stream control, simulcast, stream key\n- MANAGER: All of the above + recordings + stream settings\n\nRETURNS: { invite: { id, inviteScope, tokenName, role, inviteCode, inviteUrl, description, status, expiresAt, createdAt } }\n\nAuthentication: Requires JWT auth as token owner.",
|
|
6143
6157
|
"operationType": "write",
|
|
6144
|
-
"authRequired":
|
|
6158
|
+
"authRequired": false,
|
|
6145
6159
|
"parameters": [
|
|
6146
6160
|
{
|
|
6147
6161
|
"name": "inviteId",
|
|
@@ -6174,7 +6188,7 @@
|
|
|
6174
6188
|
"category": "moderators",
|
|
6175
6189
|
"description": "Get invite details by code (public endpoint).\n\nReturns public information about an invite for the claim page. This is used\nby the frontend to display invite details before the user logs in to claim.\n\n**Returned info:**\n- Token name, symbol, image\n- Role to be granted\n- Invite status and expiration\n- Who created the invite\n\nRETURNS: { tokenName, tokenSymbol, tokenImage, role, description, status, expiresAt, invitedBy: { address, fullName } }\n\nAuthentication: None required (public endpoint).",
|
|
6176
6190
|
"operationType": "read",
|
|
6177
|
-
"authRequired":
|
|
6191
|
+
"authRequired": false,
|
|
6178
6192
|
"parameters": [
|
|
6179
6193
|
{
|
|
6180
6194
|
"name": "inviteCode",
|
|
@@ -6190,7 +6204,7 @@
|
|
|
6190
6204
|
"category": "moderators",
|
|
6191
6205
|
"description": "Watch for moderator management events in real-time.\n\nTriggers when moderators are added, removed, or their roles are updated. Includes:\n- MODERATOR_ADDED: New moderator invitation accepted\n- MODERATOR_REMOVED: Moderator permissions revoked\n- MODERATOR_ROLE_UPDATED: Permission level changed (e.g., to MANAGER)\n\nReturns:\n- moderatorsChanged: Number of moderator change events detected\n- events: Array of moderator events with tokenName, moderatorAddress, eventType, and role information\n\nFilter Options:\n- tokenName: Only watch changes for a specific token\n- eventType: Filter by event type ('ADDED', 'REMOVED', or 'ROLE_UPDATED')\n- moderatorAddress: Only watch changes for a specific moderator.",
|
|
6192
6206
|
"operationType": "read",
|
|
6193
|
-
"authRequired":
|
|
6207
|
+
"authRequired": false,
|
|
6194
6208
|
"parameters": [
|
|
6195
6209
|
{
|
|
6196
6210
|
"name": "tokenName",
|
|
@@ -6235,7 +6249,7 @@
|
|
|
6235
6249
|
"category": "moderators",
|
|
6236
6250
|
"description": "Get list of active moderators for a specific token.\n\nReturns all moderators currently assigned to a token, including their:\n- Address / identifier\n- Role level (MODERATOR, TECHNICAL_PRODUCER, MANAGER, OWNER)\n- Permissions (can manage chat, ban users, etc.)\n- Join date\n- Status (active, pending invitation, or inactive)\n\nUseful for understanding chat management team, permissions analysis, and access control verification.\n\nReturns: Array of moderator objects with address, role, permissions, and status.",
|
|
6237
6251
|
"operationType": "read",
|
|
6238
|
-
"authRequired":
|
|
6252
|
+
"authRequired": false,
|
|
6239
6253
|
"parameters": [
|
|
6240
6254
|
{
|
|
6241
6255
|
"name": "tokenName",
|
|
@@ -6251,7 +6265,7 @@
|
|
|
6251
6265
|
"category": "content-flags",
|
|
6252
6266
|
"description": "Create a content flag/report.\n\nTwo-tier system:\n- Chat/Comment: reason and details are optional (one-click flag)\n- Stream: reason is REQUIRED (modal flow)\n\nUse this when a user reports inappropriate content.\n\nRETURNS: { flag: { id, tokenName, contentType, contentId, reporterAddress, reportedUserAddress, reason, details, status, createdAt } }\n\nAuthentication: Requires JWT auth (logged-in user session).",
|
|
6253
6267
|
"operationType": "write",
|
|
6254
|
-
"authRequired":
|
|
6268
|
+
"authRequired": false,
|
|
6255
6269
|
"parameters": [
|
|
6256
6270
|
{
|
|
6257
6271
|
"name": "tokenName",
|
|
@@ -6465,7 +6479,7 @@
|
|
|
6465
6479
|
"category": "content-flags",
|
|
6466
6480
|
"description": "Dismiss a flag (no action taken).\n\nMarks the flag as reviewed but takes no action on the content.\nUse when the flag is invalid, unfounded, or doesn't warrant action.\n\nRETURNS: { flag: { id, status: 'DISMISSED', reviewedBy, reviewedAt, ... } }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth (token owner/moderator).",
|
|
6467
6481
|
"operationType": "write",
|
|
6468
|
-
"authRequired":
|
|
6482
|
+
"authRequired": false,
|
|
6469
6483
|
"parameters": [
|
|
6470
6484
|
{
|
|
6471
6485
|
"name": "flagId",
|
|
@@ -6482,7 +6496,7 @@
|
|
|
6482
6496
|
"category": "content-flags",
|
|
6483
6497
|
"description": "Take action on a flag.\n\nActions available:\n- DELETE_CONTENT: Remove the flagged content\n- BAN_USER: Ban the reported user from the token\n- DELETE_AND_BAN: Both delete content and ban user\n\nUse when the flag is valid and requires action.\n\nRETURNS: { flag: { id, status: 'ACTIONED', actionTaken, reviewedBy, reviewedAt, ... } }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth (token owner/moderator).",
|
|
6484
6498
|
"operationType": "write",
|
|
6485
|
-
"authRequired":
|
|
6499
|
+
"authRequired": false,
|
|
6486
6500
|
"parameters": [
|
|
6487
6501
|
{
|
|
6488
6502
|
"name": "flagId",
|
|
@@ -6510,7 +6524,7 @@
|
|
|
6510
6524
|
"category": "overseers",
|
|
6511
6525
|
"description": "Create an overseer invite.\n\nOverseers have GLOBAL platform access with MANAGER-level permissions across ALL tokens\n(current and future). This is different from moderators who have token-scoped access.\n\nCreates a magic link invite that can be shared to grant overseer access.\nThe recipient claims the invite after logging in.\n\nRETURNS: { invite: { id, inviteCode, inviteUrl, invitedBy, claimedBy, description, status, expiresAt, createdAt } }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as existing Overseer.",
|
|
6512
6526
|
"operationType": "write",
|
|
6513
|
-
"authRequired":
|
|
6527
|
+
"authRequired": false,
|
|
6514
6528
|
"parameters": [
|
|
6515
6529
|
{
|
|
6516
6530
|
"name": "description",
|
|
@@ -6533,7 +6547,7 @@
|
|
|
6533
6547
|
"category": "overseers",
|
|
6534
6548
|
"description": "List all overseer invites with cursor-based pagination and filtering.\n\nReturns a paginated list of overseer invites that can be filtered by status.\n\nRETURNS: { invites: [...], pageInfo: { hasNextPage, endCursor, hasPreviousPage, startCursor } }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as existing Overseer.",
|
|
6535
6549
|
"operationType": "read",
|
|
6536
|
-
"authRequired":
|
|
6550
|
+
"authRequired": false,
|
|
6537
6551
|
"parameters": [
|
|
6538
6552
|
{
|
|
6539
6553
|
"name": "status",
|
|
@@ -6568,7 +6582,7 @@
|
|
|
6568
6582
|
"category": "overseers",
|
|
6569
6583
|
"description": "Get overseer invite details by code (public endpoint).\n\nReturns public information about an invite for the claim page. This is used\nby the frontend to display invite details before the user logs in to claim.\n\n**Returned info:**\n- Description (if set)\n- Invite status and expiration\n- Who created the invite\n\nRETURNS: { description, status, expiresAt, invitedBy: { address, fullName } }\n\nAuthentication: None required (public endpoint).",
|
|
6570
6584
|
"operationType": "read",
|
|
6571
|
-
"authRequired":
|
|
6585
|
+
"authRequired": false,
|
|
6572
6586
|
"parameters": [
|
|
6573
6587
|
{
|
|
6574
6588
|
"name": "inviteCode",
|
|
@@ -6584,7 +6598,7 @@
|
|
|
6584
6598
|
"category": "overseers",
|
|
6585
6599
|
"description": "Claim an overseer invite.\n\nClaims an invite using the code from a magic link URL. The authenticated\nuser's wallet becomes an overseer with GLOBAL access to ALL tokens on the platform.\n\n**Requirements:**\n- Invite must be in PENDING status\n- Invite must not be expired\n\nRETURNS: { invite: { id, inviteCode, inviteUrl, invitedBy, claimedBy, description, status, expiresAt, claimedAt, createdAt } }\n\nAuthentication: Requires JWT auth.",
|
|
6586
6600
|
"operationType": "write",
|
|
6587
|
-
"authRequired":
|
|
6601
|
+
"authRequired": false,
|
|
6588
6602
|
"parameters": [
|
|
6589
6603
|
{
|
|
6590
6604
|
"name": "inviteCode",
|
|
@@ -6601,7 +6615,7 @@
|
|
|
6601
6615
|
"category": "overseers",
|
|
6602
6616
|
"description": "Revoke an overseer invite.\n\nRevokes an invite by ID, preventing it from being claimed. If already claimed,\nthe overseer loses access to the platform.\n\nRETURNS: { success: true, message: \"Invite revoked\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as existing Overseer.",
|
|
6603
6617
|
"operationType": "write",
|
|
6604
|
-
"authRequired":
|
|
6618
|
+
"authRequired": false,
|
|
6605
6619
|
"parameters": [
|
|
6606
6620
|
{
|
|
6607
6621
|
"name": "inviteId",
|
|
@@ -6618,7 +6632,7 @@
|
|
|
6618
6632
|
"category": "overseers",
|
|
6619
6633
|
"description": "List all overseers with cursor-based pagination and filtering.\n\nReturns a paginated list of overseers that can be filtered by status.\n\nRETURNS: { overseers: [...], pageInfo: { hasNextPage, endCursor, hasPreviousPage, startCursor } }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as existing Overseer.",
|
|
6620
6634
|
"operationType": "read",
|
|
6621
|
-
"authRequired":
|
|
6635
|
+
"authRequired": false,
|
|
6622
6636
|
"parameters": [
|
|
6623
6637
|
{
|
|
6624
6638
|
"name": "status",
|
|
@@ -6651,7 +6665,7 @@
|
|
|
6651
6665
|
"category": "overseers",
|
|
6652
6666
|
"description": "Create an overseer directly (bypassing invite flow).\n\nDirectly promotes a user to overseer status without requiring them to claim an invite.\nA synthetic invite record is created for audit trail.\n\nUse this when you need to promote someone programmatically without requiring their\ninteraction (e.g., CLI admin tools, automated tests).\n\nRETURNS: { overseer: { id, userAddress, inviteId, status, createdAt } }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as existing Overseer.",
|
|
6653
6667
|
"operationType": "write",
|
|
6654
|
-
"authRequired":
|
|
6668
|
+
"authRequired": false,
|
|
6655
6669
|
"parameters": [
|
|
6656
6670
|
{
|
|
6657
6671
|
"name": "userAddress",
|
|
@@ -6673,7 +6687,7 @@
|
|
|
6673
6687
|
"category": "overseers",
|
|
6674
6688
|
"description": "Revoke an overseer's access.\n\nRevokes an overseer by wallet address, removing their global platform access.\n\nRETURNS: { success: true, message: \"Overseer access revoked\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as existing Overseer.",
|
|
6675
6689
|
"operationType": "write",
|
|
6676
|
-
"authRequired":
|
|
6690
|
+
"authRequired": false,
|
|
6677
6691
|
"parameters": [
|
|
6678
6692
|
{
|
|
6679
6693
|
"name": "address",
|
|
@@ -6690,7 +6704,7 @@
|
|
|
6690
6704
|
"category": "overseers",
|
|
6691
6705
|
"description": "Check your own overseer status.\n\nReturns whether the authenticated user is currently an active overseer\nand their details if so.\n\nRETURNS: { isOverseer: boolean, overseer?: { id, userAddress, inviteId, status, createdAt } }\n\nAuthentication: Requires JWT auth.",
|
|
6692
6706
|
"operationType": "read",
|
|
6693
|
-
"authRequired":
|
|
6707
|
+
"authRequired": false,
|
|
6694
6708
|
"parameters": [],
|
|
6695
6709
|
"topic": "overseer-invites"
|
|
6696
6710
|
},
|
|
@@ -6700,7 +6714,7 @@
|
|
|
6700
6714
|
"category": "overseers",
|
|
6701
6715
|
"description": "Get platform summary for CCTV dashboard.\n\nReturns quick counts for the overseer monitoring dashboard:\n- Active streams (pools with live streams)\n- Total viewers across all active streams\n- Pending content flags awaiting review\n- Total pools on the platform\n\nUse this for dashboard header stats. For detailed data, use:\n- gala_launchpad_fetch_pools (filter by muxStreamStatus=ACTIVE) for stream list\n- gala_launchpad_get_global_flags (status=PENDING) for pending flags\n\nRETURNS: { activeStreams, totalViewers, pendingFlags, totalPools }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer.",
|
|
6702
6716
|
"operationType": "read",
|
|
6703
|
-
"authRequired":
|
|
6717
|
+
"authRequired": false,
|
|
6704
6718
|
"parameters": [],
|
|
6705
6719
|
"topic": "overseer-invites"
|
|
6706
6720
|
},
|
|
@@ -6710,7 +6724,7 @@
|
|
|
6710
6724
|
"category": "overseers",
|
|
6711
6725
|
"description": "Get global user ban statistics.\n\nReturns the total count of active global user bans on the platform.\n\nRETURNS: { total: number }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer.",
|
|
6712
6726
|
"operationType": "read",
|
|
6713
|
-
"authRequired":
|
|
6727
|
+
"authRequired": false,
|
|
6714
6728
|
"parameters": [],
|
|
6715
6729
|
"topic": "overseer-invites"
|
|
6716
6730
|
},
|
|
@@ -6720,7 +6734,7 @@
|
|
|
6720
6734
|
"category": "overseers",
|
|
6721
6735
|
"description": "Get token ban (delisted tokens) statistics.\n\nReturns the total count of delisted/banned tokens on the platform.\n\nRETURNS: { total: number }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer.",
|
|
6722
6736
|
"operationType": "read",
|
|
6723
|
-
"authRequired":
|
|
6737
|
+
"authRequired": false,
|
|
6724
6738
|
"parameters": [],
|
|
6725
6739
|
"topic": "overseer-invites"
|
|
6726
6740
|
},
|
|
@@ -6760,7 +6774,7 @@
|
|
|
6760
6774
|
"category": "overseers",
|
|
6761
6775
|
"description": "List users with pagination and sorting (Overseer/Admin only).\n\nRetrieves a paginated list of users across the platform with optional filtering and sorting.\nUseful for overseer/admin dashboard user management.\n\n**Sort Options:**\n- address: User wallet address\n- flagsReceived: Content flags received\n- activeBans: Active bans count\n- createdAt: Account creation date (default)\n\nRETURNS: { items: [...], total: number, cursor?, pageSize }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as existing Overseer.",
|
|
6762
6776
|
"operationType": "read",
|
|
6763
|
-
"authRequired":
|
|
6777
|
+
"authRequired": false,
|
|
6764
6778
|
"parameters": [
|
|
6765
6779
|
{
|
|
6766
6780
|
"name": "search",
|
|
@@ -6810,7 +6824,7 @@
|
|
|
6810
6824
|
"category": "overseers",
|
|
6811
6825
|
"description": "Get comprehensive user summary (Admin/Overseer only).\n\nRetrieves full profile, activity metrics, ban status, and other detailed information\nfor a specific user. Perfect for overseer dashboard user detail pages.\n\nRETURNS: { address, profile: { name, image, bio }, statistics: { tokens, positions, trades }, metrics: { flagsReceived, activeBans }, createdAt }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as existing Overseer.",
|
|
6812
6826
|
"operationType": "read",
|
|
6813
|
-
"authRequired":
|
|
6827
|
+
"authRequired": false,
|
|
6814
6828
|
"parameters": [
|
|
6815
6829
|
{
|
|
6816
6830
|
"name": "userAddress",
|
|
@@ -6826,7 +6840,7 @@
|
|
|
6826
6840
|
"category": "overseers",
|
|
6827
6841
|
"description": "Flush all cache entries for a wallet address.\n\nClears all cached data associated with the specified address including:\n- User profile data (profile:data:*, profile:stats:*)\n- Overseer status\n- Owned tokens list\n- Ban status (global and per-token)\n- Moderator access entries\n\nUse this when:\n- User data appears stale or incorrect\n- After debugging user-specific issues\n- Resolving profile display inconsistencies\n\nRETURNS: { flushedCount, duration, target }\n- flushedCount: Number of cache keys flushed\n- duration: Time taken in milliseconds\n- target: Normalized address that was flushed\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as existing Overseer.",
|
|
6828
6842
|
"operationType": "write",
|
|
6829
|
-
"authRequired":
|
|
6843
|
+
"authRequired": false,
|
|
6830
6844
|
"parameters": [
|
|
6831
6845
|
{
|
|
6832
6846
|
"name": "address",
|
|
@@ -6842,7 +6856,7 @@
|
|
|
6842
6856
|
"category": "overseers",
|
|
6843
6857
|
"description": "Flush all cache entries for a token.\n\nClears all cached data associated with the specified token including:\n- Stream chat messages and pinned messages\n- Recordings list\n- Holders data and rankings\n- Token ban status\n- Price data (GALA and USD)\n- Vault address mapping\n\nUse this when:\n- Token data appears stale or incorrect\n- Chat/stream data seems outdated\n- Price or holder data is inconsistent\n- After modifying token settings\n\nRETURNS: { flushedCount, duration, target }\n- flushedCount: Number of cache keys flushed\n- duration: Time taken in milliseconds\n- target: Normalized token name that was flushed\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as existing Overseer.",
|
|
6844
6858
|
"operationType": "read",
|
|
6845
|
-
"authRequired":
|
|
6859
|
+
"authRequired": false,
|
|
6846
6860
|
"parameters": [
|
|
6847
6861
|
{
|
|
6848
6862
|
"name": "tokenName",
|
|
@@ -6858,7 +6872,7 @@
|
|
|
6858
6872
|
"category": "overseers",
|
|
6859
6873
|
"description": "⚠️ NUCLEAR OPTION: Flush ALL Launchpad cache.\n\nClears ALL cached data across the entire Launchpad platform. This includes:\n- All user profile data\n- All token data (chat, recordings, holders, prices)\n- All overseer/moderator access data\n- All ban status data\n- Site configuration cache\n- Everything else\n\n**WARNING:** This will cause a temporary performance hit as all data\nneeds to be re-fetched from the database. Use only when absolutely necessary.\n\n**Safety Feature:** Requires confirm=true to prevent accidental usage.\n\nUse this when:\n- Major cache corruption suspected\n- After database migrations\n- Debugging platform-wide issues\n- Testing cache behavior\n\nRETURNS: { flushedCount, duration }\n- flushedCount: Total number of cache keys flushed\n- duration: Time taken in milliseconds\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as existing Overseer.",
|
|
6860
6874
|
"operationType": "read",
|
|
6861
|
-
"authRequired":
|
|
6875
|
+
"authRequired": false,
|
|
6862
6876
|
"parameters": [
|
|
6863
6877
|
{
|
|
6864
6878
|
"name": "confirm",
|
|
@@ -6890,7 +6904,7 @@
|
|
|
6890
6904
|
"category": "token-ban",
|
|
6891
6905
|
"description": "Ban a token from the platform (overseer only).\n\nWhen a token is banned:\n- Hidden from ALL pool listings (including creator's profile)\n- Comments blocked on banned tokens\n- Live streaming blocked on banned tokens\n- Chat messages blocked on banned tokens\n- Trading NOT blocked (GalaChain handles trading independently)\n\nToken bans are permanent until explicitly removed by an overseer.\n\nRETURNS: { ban: { id, tokenName, reason, bannedBy, createdAt, updatedAt }, tokenName }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth with overseer status.",
|
|
6892
6906
|
"operationType": "read",
|
|
6893
|
-
"authRequired":
|
|
6907
|
+
"authRequired": false,
|
|
6894
6908
|
"parameters": [
|
|
6895
6909
|
{
|
|
6896
6910
|
"name": "tokenName",
|
|
@@ -6913,7 +6927,7 @@
|
|
|
6913
6927
|
"category": "token-ban",
|
|
6914
6928
|
"description": "Remove a ban from a token (overseer only).\n\nWhen a token is unbanned:\n- Restored to all pool listings\n- Visible on creator's profile again\n- Comments re-enabled\n- Live streaming re-enabled\n- Chat re-enabled\n\nRETURNS: { removed: true, tokenName }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth with overseer status.",
|
|
6915
6929
|
"operationType": "read",
|
|
6916
|
-
"authRequired":
|
|
6930
|
+
"authRequired": false,
|
|
6917
6931
|
"parameters": [
|
|
6918
6932
|
{
|
|
6919
6933
|
"name": "tokenName",
|
|
@@ -6993,7 +7007,7 @@
|
|
|
6993
7007
|
"category": "token-ban",
|
|
6994
7008
|
"description": "Watch for token ban and unban events in real-time.\n\nTriggers when tokens are banned or unbanned by administrators. Includes:\n- TOKEN_BANNED: Token removed from trading/creation due to policy violation\n- TOKEN_UNBANNED: Ban lifted, token restored to normal status\n\nReturns:\n- tokenBansChanged: Number of ban status change events detected\n- events: Array of ban events with tokenName, newBanStatus, reason, and timestamp\n\nFilter Options:\n- tokenName: Only watch ban changes for a specific token\n- banStatus: Filter by status ('BANNED' or 'UNBANNED').",
|
|
6995
7009
|
"operationType": "read",
|
|
6996
|
-
"authRequired":
|
|
7010
|
+
"authRequired": false,
|
|
6997
7011
|
"parameters": [
|
|
6998
7012
|
{
|
|
6999
7013
|
"name": "tokenName",
|
|
@@ -7031,7 +7045,7 @@
|
|
|
7031
7045
|
"category": "messages",
|
|
7032
7046
|
"description": "Query messages with type/tokenName/userAddress filters.\n\nReturns paginated list of messages using cursor-based pagination.\nAt least one of type, tokenName, or userAddress must be provided.\nPublic endpoint - no authentication required.\n\n**Filter Combinations:**\n- type=CHAT + tokenName → Chat messages for a token\n- type=COMMENT + tokenName → Comments for a token\n- userAddress → All messages from a user\n- type + userAddress → User's messages of a specific type\n\n**Message Fields:**\n- id: Unique message ID (for updates/deletes/reactions)\n- type: CHAT or COMMENT\n- tokenName, tokenImage: Pool information\n- userAddress, userProfile: Author information\n- content: Message text\n- createdAt, updatedAt: Timestamps\n- reactions: Reaction counts by emoji type\n- flagCount: Number of flags against this message\n- holderTier?: Token holder tier badge ({ tier: 0-5, tierName: string })\n- isPinned?: Whether this message is pinned (CHAT only)\n\nRETURNS: {\n messages: [...],\n pageInfo: { hasNextPage, endCursor, hasPreviousPage, startCursor }\n}\n\nAuthentication: None required (public endpoint)",
|
|
7033
7047
|
"operationType": "read",
|
|
7034
|
-
"authRequired":
|
|
7048
|
+
"authRequired": true,
|
|
7035
7049
|
"parameters": [
|
|
7036
7050
|
{
|
|
7037
7051
|
"name": "type",
|
|
@@ -7082,7 +7096,7 @@
|
|
|
7082
7096
|
"category": "messages",
|
|
7083
7097
|
"description": "Create a new message on a token pool.\n\nPosts a message to the specified token as either a CHAT message or COMMENT.\nMessages are stored in the unified pool_messages table.\n\n**Content Limits:**\n- CHAT: 1-500 characters\n- COMMENT: 1-2000 characters\n\nRETURNS: {\n message: {\n id, type, tokenName, tokenImage, userAddress, userProfile,\n content, createdAt, deletedAt, flagCount, reactions, holderTier?\n }\n}\n\nholderTier is present if the author holds tokens ({ tier: 0-5, tierName: string }).\n\nUse the returned id with gala_launchpad_update_message or gala_launchpad_delete_message.\n\nAuthentication: Requires JWT session (call gala_launchpad_login first)",
|
|
7084
7098
|
"operationType": "write",
|
|
7085
|
-
"authRequired":
|
|
7099
|
+
"authRequired": false,
|
|
7086
7100
|
"parameters": [
|
|
7087
7101
|
{
|
|
7088
7102
|
"name": "type",
|
|
@@ -7115,7 +7129,7 @@
|
|
|
7115
7129
|
"category": "messages",
|
|
7116
7130
|
"description": "Update a message's content.\n\nUpdates the content of an existing message (CHAT or COMMENT).\nOnly the original author can update their message.\nThe message will have an updatedAt timestamp after editing.\n\nRETURNS: {\n message: {\n id, type, tokenName, tokenImage, userAddress, userProfile,\n content, createdAt, updatedAt, deletedAt, flagCount, reactions\n }\n}\n\nAuthentication: Requires JWT session (call gala_launchpad_login first)\nAuthorization: Message author only.",
|
|
7117
7131
|
"operationType": "write",
|
|
7118
|
-
"authRequired":
|
|
7132
|
+
"authRequired": false,
|
|
7119
7133
|
"parameters": [
|
|
7120
7134
|
{
|
|
7121
7135
|
"name": "id",
|
|
@@ -7138,7 +7152,7 @@
|
|
|
7138
7152
|
"category": "messages",
|
|
7139
7153
|
"description": "Delete a message.\n\nSoft-deletes a message (CHAT or COMMENT) from the pool.\n\n**Authorization:**\n- Message author (JWT auth)\n- Pool owner (JWT auth)\n- Moderator with MANAGE_CHAT/MANAGE_COMMENTS permission (API key auth)\n- Platform overseer\n\nThe message remains in the database with deletedAt set (soft delete).\n\nRETURNS: { success: true }\n\nAuthentication: Requires JWT session OR API key with MANAGE_CHAT or MANAGE_COMMENTS permission.",
|
|
7140
7154
|
"operationType": "write",
|
|
7141
|
-
"authRequired":
|
|
7155
|
+
"authRequired": false,
|
|
7142
7156
|
"parameters": [
|
|
7143
7157
|
{
|
|
7144
7158
|
"name": "id",
|
|
@@ -7172,7 +7186,7 @@
|
|
|
7172
7186
|
"category": "messages",
|
|
7173
7187
|
"description": "Pin a message to a token's chat.\n\nOnly one message can be pinned per token at a time.\nPinning a new message automatically unpins any previously pinned message.\n\n**Authorization:**\n- Token owner (JWT auth)\n- Moderator with MANAGER or MODERATOR role (JWT or API key)\n\nRETURNS: { success: true }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth (token owner)",
|
|
7174
7188
|
"operationType": "read",
|
|
7175
|
-
"authRequired":
|
|
7189
|
+
"authRequired": false,
|
|
7176
7190
|
"parameters": [
|
|
7177
7191
|
{
|
|
7178
7192
|
"name": "id",
|
|
@@ -7189,7 +7203,7 @@
|
|
|
7189
7203
|
"category": "messages",
|
|
7190
7204
|
"description": "Unpin a message from a token's chat.\n\nRemoves the pinned status from a message.\n\n**Authorization:**\n- Token owner (JWT auth)\n- Moderator with MANAGER or MODERATOR role (JWT or API key)\n\nRETURNS: { success: true }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth (token owner)",
|
|
7191
7205
|
"operationType": "read",
|
|
7192
|
-
"authRequired":
|
|
7206
|
+
"authRequired": false,
|
|
7193
7207
|
"parameters": [
|
|
7194
7208
|
{
|
|
7195
7209
|
"name": "id",
|
|
@@ -7226,7 +7240,7 @@
|
|
|
7226
7240
|
"category": "restricted-names",
|
|
7227
7241
|
"description": "Update the restricted token names content.\n\nReplaces the entire list with newline-separated words.\nNewlines separate individual words to restrict.\n\n**Authorization:** Overseer only (JWT)\n\nRETURNS: { success: true }",
|
|
7228
7242
|
"operationType": "write",
|
|
7229
|
-
"authRequired":
|
|
7243
|
+
"authRequired": false,
|
|
7230
7244
|
"parameters": [
|
|
7231
7245
|
{
|
|
7232
7246
|
"name": "content",
|
|
@@ -7315,7 +7329,7 @@
|
|
|
7315
7329
|
"category": "content-reactions",
|
|
7316
7330
|
"description": "Add a reaction to a chat message.\n\nConvenience wrapper for addContentReaction specifically for chat messages.\n\nRETURNS: { data: { reactions, totalCount }, created: boolean }\n\nAuthentication: Requires JWT session (call sdk.login() first).",
|
|
7317
7331
|
"operationType": "write",
|
|
7318
|
-
"authRequired":
|
|
7332
|
+
"authRequired": false,
|
|
7319
7333
|
"parameters": [
|
|
7320
7334
|
{
|
|
7321
7335
|
"name": "tokenName",
|
|
@@ -7351,7 +7365,7 @@
|
|
|
7351
7365
|
"category": "content-reactions",
|
|
7352
7366
|
"description": "Remove a reaction from a chat message.\n\nConvenience wrapper for removeContentReaction specifically for chat messages.\n\nRETURNS: { success: true }\n\nAuthentication: Requires JWT session (call sdk.login() first).",
|
|
7353
7367
|
"operationType": "write",
|
|
7354
|
-
"authRequired":
|
|
7368
|
+
"authRequired": false,
|
|
7355
7369
|
"parameters": [
|
|
7356
7370
|
{
|
|
7357
7371
|
"name": "tokenName",
|
|
@@ -7387,7 +7401,7 @@
|
|
|
7387
7401
|
"category": "content-reactions",
|
|
7388
7402
|
"description": "Add a reaction to a comment.\n\nConvenience wrapper for addContentReaction specifically for comments.\n\nRETURNS: { data: { reactions, totalCount }, created: boolean }\n\nAuthentication: Requires JWT session (call sdk.login() first).",
|
|
7389
7403
|
"operationType": "write",
|
|
7390
|
-
"authRequired":
|
|
7404
|
+
"authRequired": false,
|
|
7391
7405
|
"parameters": [
|
|
7392
7406
|
{
|
|
7393
7407
|
"name": "tokenName",
|
|
@@ -7423,7 +7437,7 @@
|
|
|
7423
7437
|
"category": "content-reactions",
|
|
7424
7438
|
"description": "Remove a reaction from a comment.\n\nConvenience wrapper for removeContentReaction specifically for comments.\n\nRETURNS: { success: true }\n\nAuthentication: Requires JWT session (call sdk.login() first).",
|
|
7425
7439
|
"operationType": "write",
|
|
7426
|
-
"authRequired":
|
|
7440
|
+
"authRequired": false,
|
|
7427
7441
|
"parameters": [
|
|
7428
7442
|
{
|
|
7429
7443
|
"name": "tokenName",
|
|
@@ -7459,7 +7473,7 @@
|
|
|
7459
7473
|
"category": "trades",
|
|
7460
7474
|
"description": "Query trades with flexible filtering options.\n\nReturns paginated list of trades with metadata using cursor-based pagination.\nAt least one of tokenName or userAddress is required.\n\nFilters:\n- tokenName: Filter by exact token name (e.g., 'anime')\n- userAddress: Filter by user wallet address\n- search: Fuzzy search by token name (ignored when tokenName is provided)\n- txnType: Filter by trade direction ('BUY' or 'SELL')\n- startDate/endDate: Filter by date range (ISO 8601)\n- minAmount/maxAmount: Filter by trade amount range\n\nRETURNS: { trades: [{ txnId, txnType, inputAmount, outputAmount, userAddress, tokenName, tokenImage, createdAt }], pageInfo: { hasNextPage, endCursor, hasPreviousPage, startCursor } }\n\nExamples:\n- Get all trades for a token: { tokenName: 'anime' }\n- Get all trades by a user: { userAddress: 'eth|123...' }\n- Get only buy trades: { tokenName: 'anime', txnType: 'BUY' }\n- Get trades in date range: { tokenName: 'anime', startDate: '2024-01-01', endDate: '2024-12-31' }\n- Get large trades: { tokenName: 'anime', minAmount: 1000 }\n\nPublic endpoint - no authentication required.",
|
|
7461
7475
|
"operationType": "read",
|
|
7462
|
-
"authRequired":
|
|
7476
|
+
"authRequired": true,
|
|
7463
7477
|
"parameters": [
|
|
7464
7478
|
{
|
|
7465
7479
|
"name": "tokenName",
|
|
@@ -7534,7 +7548,7 @@
|
|
|
7534
7548
|
"category": "trades",
|
|
7535
7549
|
"description": "Watch for new trade execution events in real-time.\n\nTriggers whenever a trade is executed on any token. Includes buy and sell trades.\n\nReturns:\n- tradesExecuted: Number of trades detected\n- trades: Array of trade events with tokenName, userAddress, tradeType (BUY/SELL), amounts, and timestamp\n\nFilter Options:\n- tokenName: Only watch trades for a specific token\n- tradeType: Filter by direction ('BUY' or 'SELL')\n- minAmount: Only notify about trades >= minAmount\n- userAddress: Only watch trades from a specific user address.",
|
|
7536
7550
|
"operationType": "write",
|
|
7537
|
-
"authRequired":
|
|
7551
|
+
"authRequired": false,
|
|
7538
7552
|
"parameters": [
|
|
7539
7553
|
{
|
|
7540
7554
|
"name": "tokenName",
|
|
@@ -7623,7 +7637,7 @@
|
|
|
7623
7637
|
"category": "holders",
|
|
7624
7638
|
"description": "Get a user's holder rank and balance for a token.\n\nReturns the user's rank (1 = largest holder), balance, and total holder count.\nUseful for understanding a user's position in the holder distribution.\n\nReturns: { rank: number, balance: string, holderCount: number }\nReturns null if user is not a holder of the token.\n\nPublic endpoint - no authentication required.",
|
|
7625
7639
|
"operationType": "read",
|
|
7626
|
-
"authRequired":
|
|
7640
|
+
"authRequired": true,
|
|
7627
7641
|
"parameters": [
|
|
7628
7642
|
{
|
|
7629
7643
|
"name": "tokenName",
|
|
@@ -7646,7 +7660,7 @@
|
|
|
7646
7660
|
"category": "holders",
|
|
7647
7661
|
"description": "Get top token holders by balance.\n\nReturns a paginated list of the largest token holders, including their address,\nbalance, and percentage of total supply. Default returns top 10 holders.\n\nReturns: Array of { address: string, balance: string, percentage: number, rank: number }\n\nPublic endpoint - no authentication required.",
|
|
7648
7662
|
"operationType": "read",
|
|
7649
|
-
"authRequired":
|
|
7663
|
+
"authRequired": true,
|
|
7650
7664
|
"parameters": [
|
|
7651
7665
|
{
|
|
7652
7666
|
"name": "tokenName",
|
|
@@ -7669,7 +7683,7 @@
|
|
|
7669
7683
|
"category": "holders",
|
|
7670
7684
|
"description": "Get holder statistics for a token.\n\nReturns the total number of holders and the total supply across all holders.\n\nReturns: { count: number, totalBalance: string }\n\nPublic endpoint - no authentication required.",
|
|
7671
7685
|
"operationType": "read",
|
|
7672
|
-
"authRequired":
|
|
7686
|
+
"authRequired": true,
|
|
7673
7687
|
"parameters": [
|
|
7674
7688
|
{
|
|
7675
7689
|
"name": "tokenName",
|
|
@@ -7686,7 +7700,7 @@
|
|
|
7686
7700
|
"category": "holders",
|
|
7687
7701
|
"description": "Query holders by balance range.\n\nReturns holders whose balance falls within the specified min/max range.\nUseful for analyzing holder distribution across different tiers.\n\nReturns: Array of { address: string, balance: string, percentage: number, rank: number }\n\nPublic endpoint - no authentication required.",
|
|
7688
7702
|
"operationType": "read",
|
|
7689
|
-
"authRequired":
|
|
7703
|
+
"authRequired": true,
|
|
7690
7704
|
"parameters": [
|
|
7691
7705
|
{
|
|
7692
7706
|
"name": "tokenName",
|
|
@@ -7721,7 +7735,7 @@
|
|
|
7721
7735
|
"category": "holders",
|
|
7722
7736
|
"description": "Get recent trade history for a specific holder.\n\nReturns the most recent trades that affected a user's holdings for a token.\nUseful for understanding how a holder's position was built up.\n\nReturns: { trades: [{ txnId, txnType, inputAmount, outputAmount, createdAt }], pageInfo: { hasNextPage, endCursor } }\n\nPublic endpoint - no authentication required.",
|
|
7723
7737
|
"operationType": "read",
|
|
7724
|
-
"authRequired":
|
|
7738
|
+
"authRequired": true,
|
|
7725
7739
|
"parameters": [
|
|
7726
7740
|
{
|
|
7727
7741
|
"name": "tokenName",
|
|
@@ -7756,7 +7770,7 @@
|
|
|
7756
7770
|
"category": "global-feed",
|
|
7757
7771
|
"description": "Reference: Subscribe to the global feed for real-time updates.\n\n**IMPORTANT**: The global feed is a CLIENT-SIDE feature that requires the SDK to be initialized with WebSocket support.\nThis tool provides documentation. Actual subscription happens in your client code.\n\n## Global Feed Overview\n\nThe global feed broadcasts all important platform events to all subscribed clients:\n\n### Token Events (real-time for all tokens):\n- **stream_status**: Stream active/idle/disabled changes\n- **trade_executed**: Buy/sell trades on bonding curves\n- **holder_count_updated**: Holder count changes\n- **pool_badge_assigned**: Token badge assignments\n- **viewer_count**: Live viewer count updates\n\n### Site Config Events (platform-wide):\n- **site_config_changed**: Generic config changes\n- **stream_global_status**: Global streaming enabled/disabled\n- **chat_global_status**: Global chat enabled/disabled\n- **comments_global_status**: Global comments enabled/disabled\n- **webhooks_global_status**: Global webhooks enabled/disabled\n\n## Usage in Client Code\n\n### React/TypeScript (using SDK hooks):\n```typescript\nimport { useGlobalFeed, useGlobalFeedFiltered } from '@gala-chain/launchpad-sdk';\n\n// Basic subscription\nconst { isSubscribed, siteConfig } = useGlobalFeed({ autoSubscribe: true });\n\n// Filtered subscription\nconst { events } = useGlobalFeedFiltered({\n tokenNames: ['token1', 'token2'],\n eventTypes: ['trade_executed']\n});\n```\n\n### Vanilla JS (using StreamWebSocketService):\n```typescript\nimport { StreamWebSocketService } from '@gala-chain/launchpad-sdk';\n\nconst service = new StreamWebSocketService({\n url: 'wss://api.launchpad.gala.com/ws',\n authToken: token\n});\n\nawait service.connect();\nawait service.subscribeToGlobalFeed({\n onTradeExecuted: (event) => console.log('Trade:', event),\n onStreamGlobalStatus: (event) => console.log('Stream status:', event)\n});\n```\n\n## Documentation\n\nFull guides available in the SDK:\n- Quick Start (5 min): docs/websocket/QUICKSTART.md\n- Complete Guide: docs/websocket/GLOBAL-FEED.md\n- Authentication: docs/websocket/AUTHENTICATION.md\n- Examples: examples/global-feed-demo.ts, examples/global-feed-filtering-demo.ts\n\nAuthentication: None required (public endpoint)",
|
|
7758
7772
|
"operationType": "read",
|
|
7759
|
-
"authRequired":
|
|
7773
|
+
"authRequired": false,
|
|
7760
7774
|
"parameters": []
|
|
7761
7775
|
},
|
|
7762
7776
|
"unsubscribeFromGlobalFeedReference": {
|
|
@@ -7765,7 +7779,7 @@
|
|
|
7765
7779
|
"category": "global-feed",
|
|
7766
7780
|
"description": "Reference: Unsubscribe from the global feed.\n\n**IMPORTANT**: The global feed is a CLIENT-SIDE feature in the SDK.\nThis tool provides documentation. Unsubscription happens in your client code.\n\n## When to Unsubscribe\n\nUnsubscribe from the global feed when:\n- Component unmounts (React)\n- User navigates away\n- Feature is no longer needed\n- Application is shutting down\n- Connection is being closed\n\n## Unsubscribing\n\n### React/TypeScript (using SDK hooks):\n```typescript\nimport { useEffect } from 'react';\nimport { useGlobalFeed } from '@gala-chain/launchpad-sdk';\n\nexport function HomePage() {\n const { isSubscribed, unsubscribe } = useGlobalFeed();\n\n useEffect(() => {\n // Subscribe on mount (auto via hook)\n\n // Cleanup on unmount\n return () => {\n if (isSubscribed) {\n unsubscribe();\n console.log('Unsubscribed from global feed');\n }\n };\n }, [isSubscribed, unsubscribe]);\n\n return <div>{/* content */}</div>;\n}\n```\n\n### Vanilla JS (using StreamWebSocketService):\n```typescript\nimport { StreamWebSocketService } from '@gala-chain/launchpad-sdk';\n\nconst service = new StreamWebSocketService({\n url: 'wss://api.launchpad.gala.com/ws',\n authToken: token\n});\n\nawait service.connect();\nawait service.subscribeToGlobalFeed({\n onTradeExecuted: (event) => console.log('Trade:', event),\n onStreamStatus: (event) => console.log('Stream status:', event),\n});\n\n// Later, when done with the feed\nservice.unsubscribeFromGlobalFeed();\nconsole.log('Unsubscribed from global feed');\n\n// And finally, close the connection\nawait service.disconnect();\nconsole.log('Disconnected from WebSocket');\n```\n\n## Cleanup Sequence\n\nBest practice cleanup sequence:\n\n```typescript\n// 1. Unsubscribe from global feed\nawait service.unsubscribeFromGlobalFeed();\n\n// 2. Unsubscribe from any token detail subscriptions if needed\nawait service.unsubscribeFromToken('tokenName');\n\n// 3. Disconnect WebSocket\nawait service.disconnect();\n```\n\n## Resource Management\n\nAfter unsubscribing:\n- Event listeners stop firing\n- Memory from event buffers is freed\n- No further network traffic from feed\n- Can still reconnect/resubscribe later if needed\n\n## Errors and Edge Cases\n\n```typescript\n// Safe to unsubscribe if not subscribed\nif (isSubscribed) {\n unsubscribe();\n}\n\n// Safe to call multiple times\nunsubscribe();\nunsubscribe(); // No error\n\n// Disconnecting also unsubscribes automatically\nawait service.disconnect(); // Unsubscribes from all rooms\n```\n\n## Documentation\n\nFull guides available in the SDK:\n- Quick Start (5 min): docs/websocket/QUICKSTART.md\n- Complete Guide: docs/websocket/GLOBAL-FEED.md\n- Examples: examples/global-feed-demo.ts\n\nAuthentication: None required (public endpoint)",
|
|
7767
7781
|
"operationType": "read",
|
|
7768
|
-
"authRequired":
|
|
7782
|
+
"authRequired": false,
|
|
7769
7783
|
"parameters": []
|
|
7770
7784
|
},
|
|
7771
7785
|
"globalFeedStatusReference": {
|
|
@@ -7774,7 +7788,7 @@
|
|
|
7774
7788
|
"category": "global-feed",
|
|
7775
7789
|
"description": "Reference: Check global feed subscription status.\n\n**IMPORTANT**: The global feed is a CLIENT-SIDE feature in the SDK.\nThis tool provides documentation. Status checking happens in your client code.\n\n## Checking Subscription Status\n\n### React/TypeScript (using SDK hooks):\n```typescript\nimport { useGlobalFeed } from '@gala-chain/launchpad-sdk';\n\nconst { isSubscribed, isConnected } = useGlobalFeed({ autoSubscribe: true });\n\nif (isSubscribed && isConnected) {\n console.log('Successfully subscribed and connected to global feed');\n}\n```\n\n### Vanilla JS (using StreamWebSocketService):\n```typescript\nimport { StreamWebSocketService } from '@gala-chain/launchpad-sdk';\n\nconst service = new StreamWebSocketService({\n url: 'wss://api.launchpad.gala.com/ws',\n authToken: token\n});\n\nawait service.connect();\nconst isSubscribed = service.isSubscribedToGlobalFeed();\nconst isConnected = service.isConnected();\n\nconsole.log(`Subscription status: ${isSubscribed ? 'subscribed' : 'not subscribed'}`);\nconsole.log(`Connection status: ${isConnected ? 'connected' : 'disconnected'}`);\n```\n\n## Status Indicators\n\n- **isSubscribed**: true if you've successfully subscribed to the `global:feed` room\n- **isConnected**: true if WebSocket connection is active and authenticated\n\n## Common Status Scenarios\n\n| Subscribed | Connected | Meaning |\n|-----------|-----------|---------|\n| false | false | Not initialized - call connect() and subscribe first |\n| true | false | Subscribed but connection dropped - reconnecting automatically |\n| false | true | Connected but not subscribed - call subscribeToGlobalFeed() |\n| true | true | ✅ Ready to receive events |\n\n## Documentation\n\nFull guides available in the SDK:\n- Quick Start (5 min): docs/websocket/QUICKSTART.md\n- Complete Guide: docs/websocket/GLOBAL-FEED.md\n- Examples: examples/global-feed-demo.ts, examples/global-feed-filtering-demo.ts\n\nAuthentication: None required (public endpoint)",
|
|
7776
7790
|
"operationType": "read",
|
|
7777
|
-
"authRequired":
|
|
7791
|
+
"authRequired": false,
|
|
7778
7792
|
"parameters": []
|
|
7779
7793
|
},
|
|
7780
7794
|
"monitorGlobalFeedEventsReference": {
|
|
@@ -7783,7 +7797,7 @@
|
|
|
7783
7797
|
"category": "global-feed",
|
|
7784
7798
|
"description": "Reference: Monitor and filter global feed events.\n\n**IMPORTANT**: The global feed is a CLIENT-SIDE feature in the SDK.\nThis tool provides documentation. Event monitoring happens in your client code.\n\n## Available Event Types\n\n### Token Events (broadcast to all subscribers):\n- **stream_status**: Stream active/idle/disabled status changed\n- **trade_executed**: Buy/sell trade on bonding curve\n- **holder_count_updated**: Holder count increased/decreased\n- **pool_badge_assigned**: Pool earned a badge\n- **viewer_count**: Live viewer count updated\n- **token_config_updated**: Unified config change (countdown, language, toggles, social links)\n- **stats_updated**: Token stats update (price, market cap, bonding curve after trades)\n\n### Site Config Events (global feature flags):\n- **site_config_changed**: Generic config change event\n- **stream_global_status**: Global streaming enabled/disabled\n- **chat_global_status**: Global chat enabled/disabled\n- **comments_global_status**: Global comments enabled/disabled\n- **webhooks_global_status**: Global webhooks enabled/disabled\n\n## Monitoring Events\n\n### React/TypeScript (using SDK hooks):\n```typescript\nimport { useGlobalFeedFiltered } from '@gala-chain/launchpad-sdk';\n\n// Monitor specific event types on specific tokens\nconst { events } = useGlobalFeedFiltered({\n tokenNames: ['bitcoin', 'ethereum'],\n eventTypes: ['trade_executed', 'stream_status'],\n maxBufferSize: 100\n});\n\n// Process buffered events\nevents.forEach(event => {\n console.log(`Event: ${event.type}`, event.data);\n});\n```\n\n### Vanilla JS (using StreamWebSocketService):\n```typescript\nimport { StreamWebSocketService } from '@gala-chain/launchpad-sdk';\n\nconst service = new StreamWebSocketService({\n url: 'wss://api.launchpad.gala.com/ws',\n authToken: token\n});\n\nawait service.connect();\nawait service.subscribeToGlobalFeed({\n onTradeExecuted: (data) => {\n console.log(`Trade on ${data.tokenName}: ${data.tradeType}`);\n },\n onStreamStatus: (data) => {\n console.log(`Stream status: ${data.status}`);\n },\n onViewerCount: (data) => {\n console.log(`Viewers: ${data.viewerCount}`);\n },\n onTokenConfigUpdated: (data) => {\n console.log(`Config updated for ${data.tokenName}`);\n },\n onStatsUpdated: (data) => {\n console.log(`Stats: ${data.tokenName} price=${data.galaPrice}`);\n },\n onStreamGlobalStatus: (data) => {\n console.log(`Streaming globally ${data.enabled ? 'enabled' : 'disabled'}`);\n },\n});\n```\n\n## Client-Side Filtering\n\nFor better performance, filter events on the client side:\n\n```typescript\n// Only process trades for visible tokens\nconst visibleTokens = new Set(['bitcoin', 'ethereum']);\n\nsocket.on('trade_executed', (data) => {\n if (visibleTokens.has(data.tokenName)) {\n updateTokenCard(data);\n }\n});\n\n// Only process site config events\nsocket.on('stream_global_status', (data) => {\n updateGlobalUI(data);\n});\n```\n\n## Use Cases\n\n1. **Homepage Card Updates**: Monitor stream_status, trade_executed, viewer_count, holder_count, stats_updated\n2. **Real-Time Charts**: Monitor stats_updated for price and volume data\n3. **Token Config Changes**: Monitor token_config_updated for countdown, language, toggle changes\n4. **Feature Availability**: Monitor site_config_changed events\n5. **Activity Feed**: Buffer and display recent events to users\n6. **Analytics**: Count and aggregate event types\n\n## Best Practices\n\n- **Buffer management**: Keep maxBufferSize reasonable (100-1000 events)\n- **Unsubscribe cleanup**: Leave the feed when the component unmounts\n- **Client-side filtering**: Filter by tokenNames to reduce processing\n- **Selective subscriptions**: Only listen to event types you need\n- **Error handling**: Handle connection drops and reconnection\n\n## Documentation\n\nFull guides available in the SDK:\n- Quick Start (5 min): docs/websocket/QUICKSTART.md\n- Complete Guide: docs/websocket/GLOBAL-FEED.md\n- Examples: examples/global-feed-demo.ts, examples/global-feed-filtering-demo.ts\n\nAuthentication: None required (public endpoint)",
|
|
7785
7799
|
"operationType": "read",
|
|
7786
|
-
"authRequired":
|
|
7800
|
+
"authRequired": false,
|
|
7787
7801
|
"parameters": []
|
|
7788
7802
|
},
|
|
7789
7803
|
"siteConfigStateReference": {
|
|
@@ -7792,7 +7806,7 @@
|
|
|
7792
7806
|
"category": "global-feed",
|
|
7793
7807
|
"description": "Reference: Access site configuration state from global feed.\n\n**IMPORTANT**: The global feed is a CLIENT-SIDE feature in the SDK.\nThis tool provides documentation. Config access happens in your client code.\n\n## Site Configuration Events\n\nThe global feed broadcasts site-wide configuration changes. Track these to know when:\n- Streaming is globally enabled/disabled\n- Chat is globally enabled/disabled\n- Comments are globally enabled/disabled\n- Webhooks are globally enabled/disabled\n\n## Accessing Config State\n\n### React/TypeScript (using SDK hooks):\n```typescript\nimport { useGlobalFeed } from '@gala-chain/launchpad-sdk';\n\nconst { siteConfig } = useGlobalFeed({ autoSubscribe: true });\n\nif (siteConfig) {\n console.log('Site Configuration:');\n console.log(' Streaming:', siteConfig.streamingEnabled ? '🟢' : '🔴');\n console.log(' Chat:', siteConfig.chatEnabled ? '🟢' : '🔴');\n console.log(' Comments:', siteConfig.commentsEnabled ? '🟢' : '🔴');\n console.log(' Webhooks:', siteConfig.webhooksEnabled ? '🟢' : '🔴');\n}\n```\n\n### Vanilla JS (using StreamWebSocketService):\n```typescript\nimport { StreamWebSocketService } from '@gala-chain/launchpad-sdk';\n\nconst service = new StreamWebSocketService({\n url: 'wss://api.launchpad.gala.com/ws',\n authToken: token\n});\n\nawait service.connect();\nawait service.subscribeToGlobalFeed({\n onStreamGlobalStatus: (data) => {\n console.log('Stream status changed:', data.enabled);\n },\n onStreamChatGlobalStatus: (data) => {\n console.log('Chat status changed:', data.enabled);\n },\n onCommentsGlobalStatus: (data) => {\n console.log('Comments status changed:', data.enabled);\n },\n onWebhooksGlobalStatus: (data) => {\n console.log('Webhooks status changed:', data.enabled);\n },\n});\n```\n\n## Site Config Interface\n\n```typescript\ninterface SiteConfigState {\n streamingEnabled: boolean; // Global streaming feature enabled\n chatEnabled: boolean; // Global chat feature enabled\n commentsEnabled: boolean; // Global comments feature enabled\n webhooksEnabled: boolean; // Global webhooks feature enabled\n lastUpdated: ISO8601 string; // When config was last updated\n}\n```\n\n## Events\n\n- **site_config_changed**: Generic config change (includes all flags)\n- **stream_global_status**: Streaming enabled/disabled globally\n- **chat_global_status**: Chat enabled/disabled globally\n- **comments_global_status**: Comments enabled/disabled globally\n- **webhooks_global_status**: Webhooks enabled/disabled globally\n\n## Use Cases\n\n1. **Disable UI features**: If streaming is disabled, don't show stream controls\n2. **Show status messages**: Inform users when features are globally unavailable\n3. **Enable/disable monitoring**: Only set up detailed monitoring if features are enabled\n4. **Real-time notifications**: Notify users when features become available/unavailable\n\n## Documentation\n\nFull guides available in the SDK:\n- Quick Start (5 min): docs/websocket/QUICKSTART.md\n- Complete Guide: docs/websocket/GLOBAL-FEED.md\n- Examples: examples/site-config-demo.ts\n\nAuthentication: None required (public endpoint)",
|
|
7794
7808
|
"operationType": "read",
|
|
7795
|
-
"authRequired":
|
|
7809
|
+
"authRequired": false,
|
|
7796
7810
|
"parameters": []
|
|
7797
7811
|
},
|
|
7798
7812
|
"emitTradeExecuted": {
|
|
@@ -7801,7 +7815,7 @@
|
|
|
7801
7815
|
"category": "websocket-admin",
|
|
7802
7816
|
"description": "Emit a trade execution event to token subscribers.\n\nBroadcasts a trade execution event to all connected clients subscribed to a token.\nPerfect for notifying traders in real-time when a trade occurs on a token.\n\n**Event Recipients:** All clients subscribed to the token:token_name room\n\nRETURNS: { success: true, message: \"Trade executed event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
7803
7817
|
"operationType": "write",
|
|
7804
|
-
"authRequired":
|
|
7818
|
+
"authRequired": false,
|
|
7805
7819
|
"parameters": [
|
|
7806
7820
|
{
|
|
7807
7821
|
"name": "tokenName",
|
|
@@ -7840,7 +7854,7 @@
|
|
|
7840
7854
|
"category": "websocket-admin",
|
|
7841
7855
|
"description": "Emit a balance update event to a specific user.\n\nNotifies a specific user that their token and/or GALA balances have changed, typically after a trade or transfer.\nPerfect for real-time wallet updates after trade execution or token transfers.\n\n**Event Recipients:** The specified user via their user:userAddress room\n\nRETURNS: { success: true, message: \"Balance updated event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
7842
7856
|
"operationType": "write",
|
|
7843
|
-
"authRequired":
|
|
7857
|
+
"authRequired": false,
|
|
7844
7858
|
"parameters": [
|
|
7845
7859
|
{
|
|
7846
7860
|
"name": "userAddress",
|
|
@@ -7909,7 +7923,7 @@
|
|
|
7909
7923
|
"category": "websocket-admin",
|
|
7910
7924
|
"description": "Emit a viewer count update event.\n\nBroadcasts updated viewer count to all connected clients subscribed to a token.\nUse this to show real-time viewer metrics during streams.\n\n**Event Recipients:** All clients subscribed to the token:token_name room\n\nRETURNS: { success: true, message: \"Viewer count event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
7911
7925
|
"operationType": "read",
|
|
7912
|
-
"authRequired":
|
|
7926
|
+
"authRequired": false,
|
|
7913
7927
|
"parameters": [
|
|
7914
7928
|
{
|
|
7915
7929
|
"name": "tokenName",
|
|
@@ -7932,7 +7946,7 @@
|
|
|
7932
7946
|
"category": "websocket-admin",
|
|
7933
7947
|
"description": "Emit a stream countdown event.\n\nNotifies all subscribers of a token when the next live stream will start.\nPerfect for building anticipation and getting viewers ready for a scheduled stream.\n\n**Event Recipients:** All clients subscribed to the token:token_name room, plus globally\n\nRETURNS: { success: true, message: \"Stream countdown event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
7934
7948
|
"operationType": "read",
|
|
7935
|
-
"authRequired":
|
|
7949
|
+
"authRequired": false,
|
|
7936
7950
|
"parameters": [
|
|
7937
7951
|
{
|
|
7938
7952
|
"name": "tokenName",
|
|
@@ -7961,7 +7975,7 @@
|
|
|
7961
7975
|
"category": "websocket-admin",
|
|
7962
7976
|
"description": "Emit a chat message event to token chat subscribers.\n\nBroadcasts a system or admin chat message to all connected clients in a token's chat room.\nPerfect for announcements, moderation messages, or system notifications.\n\n**Event Recipients:** All clients subscribed to the token:token_name room\n\nRETURNS: { success: true, message: \"Chat message event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
7963
7977
|
"operationType": "read",
|
|
7964
|
-
"authRequired":
|
|
7978
|
+
"authRequired": false,
|
|
7965
7979
|
"parameters": [
|
|
7966
7980
|
{
|
|
7967
7981
|
"name": "tokenName",
|
|
@@ -8019,7 +8033,7 @@
|
|
|
8019
8033
|
"category": "websocket-admin",
|
|
8020
8034
|
"description": "Emit a typing indicator event.\n\nShows which users are currently typing in a token's chat room.\nHelps create the perception of real-time conversation (e.g., \"3 users typing...\").\n\n**Event Recipients:** All clients subscribed to the token:token_name room\n\nRETURNS: { success: true, message: \"Typing indicator event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
8021
8035
|
"operationType": "read",
|
|
8022
|
-
"authRequired":
|
|
8036
|
+
"authRequired": false,
|
|
8023
8037
|
"parameters": [
|
|
8024
8038
|
{
|
|
8025
8039
|
"name": "tokenName",
|
|
@@ -8048,7 +8062,7 @@
|
|
|
8048
8062
|
"category": "websocket-admin",
|
|
8049
8063
|
"description": "Emit a token banned event.\n\nBroadcasts globally that a token has been banned from the platform.\nNotifies all connected clients about the ban for compliance and awareness.\n\n**Event Recipients:** All globally connected clients (broadcast)\n\nRETURNS: { success: true, message: \"Token banned event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
8050
8064
|
"operationType": "read",
|
|
8051
|
-
"authRequired":
|
|
8065
|
+
"authRequired": false,
|
|
8052
8066
|
"parameters": [
|
|
8053
8067
|
{
|
|
8054
8068
|
"name": "tokenName",
|
|
@@ -8083,7 +8097,7 @@
|
|
|
8083
8097
|
"category": "websocket-admin",
|
|
8084
8098
|
"description": "Emit a token unbanned event.\n\nBroadcasts globally that a previously banned token has been unbanned/restored.\nNotifies all connected clients that the token is now available again.\n\n**Event Recipients:** All globally connected clients (broadcast)\n\nRETURNS: { success: true, message: \"Token unbanned event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
8085
8099
|
"operationType": "read",
|
|
8086
|
-
"authRequired":
|
|
8100
|
+
"authRequired": false,
|
|
8087
8101
|
"parameters": [
|
|
8088
8102
|
{
|
|
8089
8103
|
"name": "tokenName",
|
|
@@ -8112,7 +8126,7 @@
|
|
|
8112
8126
|
"category": "websocket-admin",
|
|
8113
8127
|
"description": "Emit a moderator added event.\n\nNotifies subscribers that a user has been added or promoted to a moderator role.\nUseful for transparency and updating the UI with the new moderator information.\n\n**Event Recipients:** All clients subscribed to the token:token_name room\n\nRETURNS: { success: true, message: \"Moderator added event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
8114
8128
|
"operationType": "write",
|
|
8115
|
-
"authRequired":
|
|
8129
|
+
"authRequired": false,
|
|
8116
8130
|
"parameters": [
|
|
8117
8131
|
{
|
|
8118
8132
|
"name": "tokenName",
|
|
@@ -8152,7 +8166,7 @@
|
|
|
8152
8166
|
"category": "websocket-admin",
|
|
8153
8167
|
"description": "Emit a moderator removed event.\n\nNotifies subscribers that a moderator has been removed or demoted from their role.\nUseful for transparency and updating the UI with the change in moderator status.\n\n**Event Recipients:** All clients subscribed to the token:token_name room\n\nRETURNS: { success: true, message: \"Moderator removed event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
8154
8168
|
"operationType": "write",
|
|
8155
|
-
"authRequired":
|
|
8169
|
+
"authRequired": false,
|
|
8156
8170
|
"parameters": [
|
|
8157
8171
|
{
|
|
8158
8172
|
"name": "tokenName",
|
|
@@ -8181,7 +8195,7 @@
|
|
|
8181
8195
|
"category": "websocket-admin",
|
|
8182
8196
|
"description": "Emit a user profile updated event.\n\nNotifies a specific user that their profile has been updated (e.g., avatar, display name, bio).\nUseful for real-time profile synchronization across all their connected sessions/devices.\n\n**Event Recipients:** The specified user via their user:userAddress room\n\nRETURNS: { success: true, message: \"User profile updated event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
8183
8197
|
"operationType": "write",
|
|
8184
|
-
"authRequired":
|
|
8198
|
+
"authRequired": false,
|
|
8185
8199
|
"parameters": [
|
|
8186
8200
|
{
|
|
8187
8201
|
"name": "userAddress",
|
|
@@ -8210,7 +8224,7 @@
|
|
|
8210
8224
|
"category": "websocket-admin",
|
|
8211
8225
|
"description": "Emit a site configuration changed event.\n\nBroadcasts globally that the site configuration has changed (e.g., maintenance mode, trading disabled, fees updated).\nNotifies all connected clients about platform-wide changes requiring immediate awareness.\n\n**Event Recipients:** All globally connected clients (broadcast)\n\nRETURNS: { success: true, message: \"Site config changed event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
8212
8226
|
"operationType": "read",
|
|
8213
|
-
"authRequired":
|
|
8227
|
+
"authRequired": false,
|
|
8214
8228
|
"parameters": [
|
|
8215
8229
|
{
|
|
8216
8230
|
"name": "key",
|
|
@@ -8325,7 +8339,7 @@
|
|
|
8325
8339
|
"category": "websocket-admin",
|
|
8326
8340
|
"description": "Emit a recordings count updated event.\n\nNotifies all connected clients subscribed to a token that the number of available recordings has changed.\nUse this when recordings are added, removed, or become available to update UI counters.\n\n**Event Recipients:** All clients subscribed to the token:token_name room\n\nRETURNS: { success: true, message: \"Recordings count updated event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
8327
8341
|
"operationType": "write",
|
|
8328
|
-
"authRequired":
|
|
8342
|
+
"authRequired": false,
|
|
8329
8343
|
"parameters": [
|
|
8330
8344
|
{
|
|
8331
8345
|
"name": "tokenName",
|
|
@@ -8353,7 +8367,7 @@
|
|
|
8353
8367
|
"category": "websocket-admin",
|
|
8354
8368
|
"description": "Emit a download ready event.\n\nNotifies all connected clients subscribed to a token that a recording download is ready.\nUse this when Mux has finished processing a recording and made it available for download.\n\n**Event Recipients:** All clients subscribed to the token:token_name room\n\nRETURNS: { success: true, message: \"Download ready event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
8355
8369
|
"operationType": "read",
|
|
8356
|
-
"authRequired":
|
|
8370
|
+
"authRequired": false,
|
|
8357
8371
|
"parameters": [
|
|
8358
8372
|
{
|
|
8359
8373
|
"name": "tokenName",
|
|
@@ -8405,7 +8419,7 @@
|
|
|
8405
8419
|
"category": "websocket-admin",
|
|
8406
8420
|
"description": "Emit a generic WebSocket event (advanced/custom use).\n\nFor most use cases, use the specific boutique tools like:\n- gala_launchpad_emit_trade_executed\n- gala_launchpad_emit_chat_message\n- gala_launchpad_emit_stream_status\n- etc.\n\nThis generic tool is for advanced scenarios where you need custom event payloads\nor actions not covered by the boutique helpers.\n\n**Event Routing:**\n- If tokenName: Routes to token:tokenName room\n- If userAddress: Routes to user:userAddress room\n- If broadcast=true: Routes to global room\n\n**Payload Format:**\nProvide a JSON object with custom event data. Structure depends on your event type.\n\nRETURNS: { success: true, message: \"Event emitted\" }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
8407
8421
|
"operationType": "read",
|
|
8408
|
-
"authRequired":
|
|
8422
|
+
"authRequired": false,
|
|
8409
8423
|
"parameters": [
|
|
8410
8424
|
{
|
|
8411
8425
|
"name": "action",
|
|
@@ -8462,7 +8476,7 @@
|
|
|
8462
8476
|
"category": "websocket-admin",
|
|
8463
8477
|
"description": "List currently connected WebSocket clients with optional filtering.\n\nReturns a paginated list of connected WebSocket clients, with optional filters\nfor room, token, user addresses, authentication status, and connection duration.\nUseful for monitoring active connections and targeting specific audiences.\n\n**Query Parameters:**\n- room: Filter by room name (e.g., \"token:anime\")\n- tokenName: Shorthand for room=token:{name}\n- userAddress: Find specific user (exact match)\n- userAddresses: Find any of these users (comma-separated)\n- authenticated: Filter by auth status\n- isOverseer: Filter by admin/overseer status\n- minConnectionSeconds: Only clients connected longer than X seconds\n- offset/limit: Pagination\n\n**Connection Info Includes:**\n- Socket ID\n- Wallet address (if authenticated)\n- Authentication status\n- Connected rooms (subscribed channels)\n- Connection duration\n- Last activity timestamp\n\nRETURNS: {\n clients: [\n {\n socketId, address?, authenticated, connectedAt, lastActivity, rooms: [...]\n }\n ],\n summary: {\n totalConnected, authenticatedCount, anonymousCount,\n overseerCount, requestedUsersOnline,\n rooms: [{ room, connectedCount, authenticatedCount }, ...]\n },\n pagination: { offset, limit, total, hasMore }\n}\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
8464
8478
|
"operationType": "read",
|
|
8465
|
-
"authRequired":
|
|
8479
|
+
"authRequired": true,
|
|
8466
8480
|
"parameters": [
|
|
8467
8481
|
{
|
|
8468
8482
|
"name": "room",
|
|
@@ -8590,7 +8604,7 @@
|
|
|
8590
8604
|
"category": "websocket-admin",
|
|
8591
8605
|
"description": "Get list of currently online overseers and admins.\n\nUseful for:\n- Finding active admins to notify about urgent issues\n- Checking if any overseers are online before admin events\n- Broadcasting to all online admins\n\nRETURNS: {\n clients: [list of overseer clients],\n count: total overseer count\n}\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth as Overseer",
|
|
8592
8606
|
"operationType": "read",
|
|
8593
|
-
"authRequired":
|
|
8607
|
+
"authRequired": false,
|
|
8594
8608
|
"parameters": [],
|
|
8595
8609
|
"topic": "websocket-admin"
|
|
8596
8610
|
},
|
|
@@ -8609,7 +8623,7 @@
|
|
|
8609
8623
|
"category": "ai-moderation",
|
|
8610
8624
|
"description": "Update AI moderation settings.\n\nConfigure AI-powered content moderation behavior.\nOnly provided fields will be updated.\n\nRETURNS: { settings: { enabled, mode, provider, ... } }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth (overseer).",
|
|
8611
8625
|
"operationType": "write",
|
|
8612
|
-
"authRequired":
|
|
8626
|
+
"authRequired": false,
|
|
8613
8627
|
"parameters": [
|
|
8614
8628
|
{
|
|
8615
8629
|
"name": "enabled",
|
|
@@ -8657,7 +8671,7 @@
|
|
|
8657
8671
|
"category": "ai-moderation",
|
|
8658
8672
|
"description": "Trigger AI moderation for a content flag.\n\nQueues flagged content for AI moderation. Moderation runs asynchronously -\nuse gala_launchpad_get_ai_moderation_result to poll for results or listen\nfor the AI_MODERATION_COMPLETE WebSocket event.\n\nFor video content with tiered analysis enabled:\n- Quick scan runs first (5 frames at 480px)\n- If concerns found, detailed scan runs (20 frames at 640px)\n\nRETURNS: { queued: boolean, message: string }\n\nAuthentication: Requires streamAdminApiKey (admin) OR JWT auth (overseer).",
|
|
8659
8673
|
"operationType": "read",
|
|
8660
|
-
"authRequired":
|
|
8674
|
+
"authRequired": false,
|
|
8661
8675
|
"parameters": [
|
|
8662
8676
|
{
|
|
8663
8677
|
"name": "flagId",
|
|
@@ -9028,6 +9042,31 @@
|
|
|
9028
9042
|
],
|
|
9029
9043
|
"category": "dex"
|
|
9030
9044
|
},
|
|
9045
|
+
"gdex-stream": {
|
|
9046
|
+
"key": "gdex-stream",
|
|
9047
|
+
"label": "Gdex stream",
|
|
9048
|
+
"description": "Gdex stream operations",
|
|
9049
|
+
"methods": [
|
|
9050
|
+
"connect",
|
|
9051
|
+
"disconnect",
|
|
9052
|
+
"isConnected",
|
|
9053
|
+
"request",
|
|
9054
|
+
"serverInfo",
|
|
9055
|
+
"ping",
|
|
9056
|
+
"getPool",
|
|
9057
|
+
"getBalance",
|
|
9058
|
+
"getPositions",
|
|
9059
|
+
"getBlockHeight",
|
|
9060
|
+
"quote",
|
|
9061
|
+
"getToken",
|
|
9062
|
+
"subscribeSwaps",
|
|
9063
|
+
"subscribePool",
|
|
9064
|
+
"subscribeBalances",
|
|
9065
|
+
"subscribePoolCreated",
|
|
9066
|
+
"subscribeBlocks"
|
|
9067
|
+
],
|
|
9068
|
+
"category": "utils"
|
|
9069
|
+
},
|
|
9031
9070
|
"error-handling": {
|
|
9032
9071
|
"key": "error-handling",
|
|
9033
9072
|
"label": "Error handling",
|
|
@@ -9724,6 +9763,17 @@
|
|
|
9724
9763
|
},
|
|
9725
9764
|
"authMatrix": {
|
|
9726
9765
|
"public": [
|
|
9766
|
+
"actionFlag",
|
|
9767
|
+
"addLiquidityByPrice",
|
|
9768
|
+
"addLiquidityByTicks",
|
|
9769
|
+
"addReactionToChatMessage",
|
|
9770
|
+
"addReactionToComment",
|
|
9771
|
+
"addSimulcastTarget",
|
|
9772
|
+
"banToken",
|
|
9773
|
+
"bridgeIn",
|
|
9774
|
+
"bridgeOut",
|
|
9775
|
+
"burnTokens",
|
|
9776
|
+
"buy",
|
|
9727
9777
|
"calculateBuyAmount",
|
|
9728
9778
|
"calculateBuyAmountExternal",
|
|
9729
9779
|
"calculateBuyAmountForGraduation",
|
|
@@ -9738,10 +9788,52 @@
|
|
|
9738
9788
|
"checkPoolExists",
|
|
9739
9789
|
"checkTokenName",
|
|
9740
9790
|
"checkTokenSymbol",
|
|
9791
|
+
"claimModeratorInvite",
|
|
9792
|
+
"claimNftCollection",
|
|
9793
|
+
"claimOverseerInvite",
|
|
9794
|
+
"cleanup",
|
|
9795
|
+
"clearCache",
|
|
9796
|
+
"collectPositionFees",
|
|
9797
|
+
"createApiKey",
|
|
9798
|
+
"createBan",
|
|
9799
|
+
"createFlag",
|
|
9800
|
+
"createMessage",
|
|
9801
|
+
"createModeratorInvite",
|
|
9802
|
+
"createNftTokenClass",
|
|
9803
|
+
"createOverseerDirect",
|
|
9804
|
+
"createOverseerInvite",
|
|
9805
|
+
"createSolanaWallet",
|
|
9806
|
+
"createWallet",
|
|
9807
|
+
"deleteMessage",
|
|
9808
|
+
"deleteRecording",
|
|
9809
|
+
"dismissFlag",
|
|
9810
|
+
"emitBalanceUpdated",
|
|
9811
|
+
"emitChatMessage",
|
|
9741
9812
|
"emitChatStatus",
|
|
9813
|
+
"emitDownloadReady",
|
|
9742
9814
|
"emitFeatureStatus",
|
|
9815
|
+
"emitModeratorAdded",
|
|
9816
|
+
"emitModeratorRemoved",
|
|
9743
9817
|
"emitRecordingStatus",
|
|
9818
|
+
"emitRecordingsCountUpdated",
|
|
9819
|
+
"emitSiteConfigChanged",
|
|
9820
|
+
"emitStreamCountdown",
|
|
9744
9821
|
"emitStreamStatus",
|
|
9822
|
+
"emitTokenBanned",
|
|
9823
|
+
"emitTokenUnbanned",
|
|
9824
|
+
"emitTradeExecuted",
|
|
9825
|
+
"emitTypingIndicator",
|
|
9826
|
+
"emitUserProfileUpdated",
|
|
9827
|
+
"emitViewerCount",
|
|
9828
|
+
"emitWebsocketEvent",
|
|
9829
|
+
"ensureValidToken",
|
|
9830
|
+
"estimateBridgeFee",
|
|
9831
|
+
"estimateNftMintFee",
|
|
9832
|
+
"estimateNftOperationFees",
|
|
9833
|
+
"estimateRemoveLiquidity",
|
|
9834
|
+
"estimateUnwrapFee",
|
|
9835
|
+
"estimateWrapFee",
|
|
9836
|
+
"executeSwap",
|
|
9745
9837
|
"explainSdkUsage",
|
|
9746
9838
|
"explainWebsocketEvents",
|
|
9747
9839
|
"fetchAllAvailableDexTokens",
|
|
@@ -9773,7 +9865,6 @@
|
|
|
9773
9865
|
"fetchLaunchpadFee",
|
|
9774
9866
|
"fetchLaunchpadTokenSpotPrice",
|
|
9775
9867
|
"fetchLockedTokens",
|
|
9776
|
-
"fetchMessages",
|
|
9777
9868
|
"fetchNftBalances",
|
|
9778
9869
|
"fetchNftCollections",
|
|
9779
9870
|
"fetchNftTokenClasses",
|
|
@@ -9782,6 +9873,7 @@
|
|
|
9782
9873
|
"fetchPools",
|
|
9783
9874
|
"fetchPriceHistory",
|
|
9784
9875
|
"fetchProfile",
|
|
9876
|
+
"fetchReferralUrl",
|
|
9785
9877
|
"fetchReferrals",
|
|
9786
9878
|
"fetchReferralsSummary",
|
|
9787
9879
|
"fetchSaleDetails",
|
|
@@ -9801,7 +9893,11 @@
|
|
|
9801
9893
|
"fetchUserHolderContext",
|
|
9802
9894
|
"fetchVolumeData",
|
|
9803
9895
|
"fetchWrappableTokens",
|
|
9896
|
+
"flushAllCache",
|
|
9897
|
+
"flushCacheByAddress",
|
|
9898
|
+
"flushCacheByToken",
|
|
9804
9899
|
"getAccessToken",
|
|
9900
|
+
"getActiveModerators",
|
|
9805
9901
|
"getActiveUsers",
|
|
9806
9902
|
"getAddress",
|
|
9807
9903
|
"getAiModerationResult",
|
|
@@ -9809,33 +9905,41 @@
|
|
|
9809
9905
|
"getAiModerationStatus",
|
|
9810
9906
|
"getAllSwapUserAssets",
|
|
9811
9907
|
"getAllUserLiquidityPositions",
|
|
9908
|
+
"getApiKey",
|
|
9909
|
+
"getApiKeyRoles",
|
|
9812
9910
|
"getAvailableRoles",
|
|
9911
|
+
"getBanStats",
|
|
9912
|
+
"getBanStatus",
|
|
9813
9913
|
"getBridgeStatus",
|
|
9814
9914
|
"getBundlerTransactionResult",
|
|
9815
9915
|
"getCacheInfo",
|
|
9816
9916
|
"getChatStatus",
|
|
9817
9917
|
"getConfig",
|
|
9818
|
-
"getConnectedClients",
|
|
9819
9918
|
"getEngagementStats",
|
|
9820
9919
|
"getEnvironment",
|
|
9821
9920
|
"getEthereumAddress",
|
|
9921
|
+
"getEthereumAddressFromPrivateKey",
|
|
9822
9922
|
"getEthereumTransactionStatus",
|
|
9823
9923
|
"getEventSchema",
|
|
9824
9924
|
"getFlagStats",
|
|
9825
9925
|
"getGlobalChatStatus",
|
|
9826
9926
|
"getGlobalStreamingStatus",
|
|
9827
|
-
"getHolderCount",
|
|
9828
|
-
"getHolderHistory",
|
|
9829
|
-
"getHolderRank",
|
|
9830
|
-
"getHoldersByBalance",
|
|
9831
9927
|
"getHomeOembed",
|
|
9832
9928
|
"getInviteStats",
|
|
9833
9929
|
"getLiquidityPosition",
|
|
9834
9930
|
"getLiquidityPositionById",
|
|
9931
|
+
"getManagedTokens",
|
|
9835
9932
|
"getMessageStats",
|
|
9933
|
+
"getModeratedTokens",
|
|
9934
|
+
"getModeratorInvite",
|
|
9935
|
+
"getMyOverseerStatus",
|
|
9836
9936
|
"getNftCollectionClaimFee",
|
|
9837
9937
|
"getNftTokenClassCreateFee",
|
|
9938
|
+
"getOnlineOverseers",
|
|
9838
9939
|
"getOnlineUsers",
|
|
9940
|
+
"getOverseerInvite",
|
|
9941
|
+
"getOverseerSummary",
|
|
9942
|
+
"getOverseerUserSummary",
|
|
9839
9943
|
"getPinnedMessage",
|
|
9840
9944
|
"getPlatformStats",
|
|
9841
9945
|
"getPlatformStatus",
|
|
@@ -9843,24 +9947,27 @@
|
|
|
9843
9947
|
"getPoolRealtimeState",
|
|
9844
9948
|
"getPremintQuote",
|
|
9845
9949
|
"getProfileOembed",
|
|
9950
|
+
"getPublicKeyFromPrivateKey",
|
|
9846
9951
|
"getRecentTrades",
|
|
9847
9952
|
"getRecordingDownload",
|
|
9848
9953
|
"getRestrictedNames",
|
|
9954
|
+
"getSession",
|
|
9849
9955
|
"getSimulcastTargets",
|
|
9850
9956
|
"getSolanaTransactionStatus",
|
|
9851
9957
|
"getStreamRecordings",
|
|
9958
|
+
"getStreamRole",
|
|
9852
9959
|
"getSupportedBridgeTokens",
|
|
9853
9960
|
"getSwapPoolInfo",
|
|
9854
9961
|
"getSwapPoolPrice",
|
|
9855
9962
|
"getSwapQuoteExactInput",
|
|
9856
9963
|
"getSwapQuoteExactOutput",
|
|
9857
9964
|
"getSwapUserAssets",
|
|
9965
|
+
"getTokenAccess",
|
|
9858
9966
|
"getTokenBan",
|
|
9967
|
+
"getTokenBanStats",
|
|
9859
9968
|
"getTokenViewers",
|
|
9860
9969
|
"getTokenWeeklyHistory",
|
|
9861
|
-
"getTopHolders",
|
|
9862
9970
|
"getTradeQuote",
|
|
9863
|
-
"getTrades",
|
|
9864
9971
|
"getUrlByTokenName",
|
|
9865
9972
|
"getUserLiquidityPositions",
|
|
9866
9973
|
"getUserStats",
|
|
@@ -9870,6 +9977,10 @@
|
|
|
9870
9977
|
"getWrapCounterpart",
|
|
9871
9978
|
"getWrapStatus",
|
|
9872
9979
|
"getWrappableToken",
|
|
9980
|
+
"globalFeedReference",
|
|
9981
|
+
"globalFeedStatusReference",
|
|
9982
|
+
"graduateToken",
|
|
9983
|
+
"hasWallet",
|
|
9873
9984
|
"isAuthenticated",
|
|
9874
9985
|
"isTokenBanned",
|
|
9875
9986
|
"isTokenBridgeableToEthereum",
|
|
@@ -9878,104 +9989,16 @@
|
|
|
9878
9989
|
"isTokenGraduated",
|
|
9879
9990
|
"isTokenWrappable",
|
|
9880
9991
|
"isUserOnline",
|
|
9992
|
+
"launchToken",
|
|
9993
|
+
"listApiKeys",
|
|
9881
9994
|
"listBans",
|
|
9882
9995
|
"listFlags",
|
|
9883
9996
|
"listGlobalFlags",
|
|
9884
|
-
"listTokenBans",
|
|
9885
|
-
"resolveTokenClassKey",
|
|
9886
|
-
"resolveVaultAddress"
|
|
9887
|
-
],
|
|
9888
|
-
"authenticated": [
|
|
9889
|
-
"actionFlag",
|
|
9890
|
-
"addContentReaction",
|
|
9891
|
-
"addLiquidityByPrice",
|
|
9892
|
-
"addLiquidityByTicks",
|
|
9893
|
-
"addReactionToChatMessage",
|
|
9894
|
-
"addReactionToComment",
|
|
9895
|
-
"addSimulcastTarget",
|
|
9896
|
-
"banToken",
|
|
9897
|
-
"bridgeIn",
|
|
9898
|
-
"bridgeOut",
|
|
9899
|
-
"burnTokens",
|
|
9900
|
-
"buy",
|
|
9901
|
-
"claimModeratorInvite",
|
|
9902
|
-
"claimNftCollection",
|
|
9903
|
-
"claimOverseerInvite",
|
|
9904
|
-
"cleanup",
|
|
9905
|
-
"clearCache",
|
|
9906
|
-
"collectPositionFees",
|
|
9907
|
-
"connectStreamWebsocket",
|
|
9908
|
-
"createApiKey",
|
|
9909
|
-
"createBan",
|
|
9910
|
-
"createFlag",
|
|
9911
|
-
"createMessage",
|
|
9912
|
-
"createModeratorInvite",
|
|
9913
|
-
"createNftTokenClass",
|
|
9914
|
-
"createOverseerDirect",
|
|
9915
|
-
"createOverseerInvite",
|
|
9916
|
-
"createSolanaWallet",
|
|
9917
|
-
"createWallet",
|
|
9918
|
-
"deleteMessage",
|
|
9919
|
-
"deleteRecording",
|
|
9920
|
-
"dismissFlag",
|
|
9921
|
-
"emitBalanceUpdated",
|
|
9922
|
-
"emitChatMessage",
|
|
9923
|
-
"emitDownloadReady",
|
|
9924
|
-
"emitModeratorAdded",
|
|
9925
|
-
"emitModeratorRemoved",
|
|
9926
|
-
"emitRecordingsCountUpdated",
|
|
9927
|
-
"emitSiteConfigChanged",
|
|
9928
|
-
"emitStreamCountdown",
|
|
9929
|
-
"emitTokenBanned",
|
|
9930
|
-
"emitTokenUnbanned",
|
|
9931
|
-
"emitTradeExecuted",
|
|
9932
|
-
"emitTypingIndicator",
|
|
9933
|
-
"emitUserProfileUpdated",
|
|
9934
|
-
"emitViewerCount",
|
|
9935
|
-
"emitWebsocketEvent",
|
|
9936
|
-
"ensureValidToken",
|
|
9937
|
-
"estimateBridgeFee",
|
|
9938
|
-
"estimateNftMintFee",
|
|
9939
|
-
"estimateNftOperationFees",
|
|
9940
|
-
"estimateRemoveLiquidity",
|
|
9941
|
-
"estimateUnwrapFee",
|
|
9942
|
-
"estimateWrapFee",
|
|
9943
|
-
"executeSwap",
|
|
9944
|
-
"fetchNotificationPreferences",
|
|
9945
|
-
"fetchReferralUrl",
|
|
9946
|
-
"flushAllCache",
|
|
9947
|
-
"flushCacheByAddress",
|
|
9948
|
-
"flushCacheByToken",
|
|
9949
|
-
"flushCacheWalletAliases",
|
|
9950
|
-
"getActiveModerators",
|
|
9951
|
-
"getApiKey",
|
|
9952
|
-
"getApiKeyRoles",
|
|
9953
|
-
"getBanStats",
|
|
9954
|
-
"getBanStatus",
|
|
9955
|
-
"getEthereumAddressFromPrivateKey",
|
|
9956
|
-
"getManagedTokens",
|
|
9957
|
-
"getModeratedTokens",
|
|
9958
|
-
"getModeratorInvite",
|
|
9959
|
-
"getMyOverseerStatus",
|
|
9960
|
-
"getOnlineOverseers",
|
|
9961
|
-
"getOverseerInvite",
|
|
9962
|
-
"getOverseerSummary",
|
|
9963
|
-
"getOverseerUserSummary",
|
|
9964
|
-
"getPublicKeyFromPrivateKey",
|
|
9965
|
-
"getSession",
|
|
9966
|
-
"getStreamRole",
|
|
9967
|
-
"getTokenAccess",
|
|
9968
|
-
"getTokenBanStats",
|
|
9969
|
-
"globalFeedReference",
|
|
9970
|
-
"globalFeedStatusReference",
|
|
9971
|
-
"graduateToken",
|
|
9972
|
-
"hasWallet",
|
|
9973
|
-
"launchToken",
|
|
9974
|
-
"listApiKeys",
|
|
9975
9997
|
"listModeratorInvites",
|
|
9976
9998
|
"listOverseerInvites",
|
|
9977
9999
|
"listOverseerUsers",
|
|
9978
10000
|
"listOverseers",
|
|
10001
|
+
"listTokenBans",
|
|
9979
10002
|
"lockTokens",
|
|
9980
10003
|
"login",
|
|
9981
10004
|
"logout",
|
|
@@ -9991,23 +10014,20 @@
|
|
|
9991
10014
|
"onTradeExecuted",
|
|
9992
10015
|
"pinMessage",
|
|
9993
10016
|
"refreshToken",
|
|
9994
|
-
"registerPushToken",
|
|
9995
10017
|
"removeBan",
|
|
9996
|
-
"removeContentReaction",
|
|
9997
10018
|
"removeLiquidity",
|
|
9998
10019
|
"removeReactionFromChatMessage",
|
|
9999
10020
|
"removeReactionFromComment",
|
|
10000
10021
|
"removeSimulcastTarget",
|
|
10001
10022
|
"requestSolanaDevnetAirdrop",
|
|
10002
10023
|
"resetStreamKey",
|
|
10024
|
+
"resolveTokenClassKey",
|
|
10025
|
+
"resolveVaultAddress",
|
|
10003
10026
|
"revokeApiKey",
|
|
10004
10027
|
"revokeModeratorInvite",
|
|
10005
10028
|
"revokeOverseer",
|
|
10006
10029
|
"revokeOverseerInvite",
|
|
10007
10030
|
"sell",
|
|
10008
|
-
"sendStreamChatViaWebSocket",
|
|
10009
|
-
"sendStreamReaction",
|
|
10010
|
-
"sendTypingIndicator",
|
|
10011
10031
|
"setChatEnabled",
|
|
10012
10032
|
"setGlobalChatEnabled",
|
|
10013
10033
|
"setGlobalStreamingEnabled",
|
|
@@ -10027,7 +10047,6 @@
|
|
|
10027
10047
|
"unbanToken",
|
|
10028
10048
|
"unlockTokens",
|
|
10029
10049
|
"unpinMessage",
|
|
10030
|
-
"unregisterPushToken",
|
|
10031
10050
|
"unsubscribeFromGlobalFeedReference",
|
|
10032
10051
|
"unwrapToken",
|
|
10033
10052
|
"updateAiModerationSettings",
|
|
@@ -10035,7 +10054,6 @@
|
|
|
10035
10054
|
"updateMessage",
|
|
10036
10055
|
"updateModeratorInvite",
|
|
10037
10056
|
"updateModeratorInviteRole",
|
|
10038
|
-
"updateNotificationPreferences",
|
|
10039
10057
|
"updateProfile",
|
|
10040
10058
|
"updateRestrictedNames",
|
|
10041
10059
|
"updateTokenConfig",
|
|
@@ -10043,6 +10061,27 @@
|
|
|
10043
10061
|
"uploadTokenImage",
|
|
10044
10062
|
"validateToken",
|
|
10045
10063
|
"wrapToken"
|
|
10064
|
+
],
|
|
10065
|
+
"authenticated": [
|
|
10066
|
+
"addContentReaction",
|
|
10067
|
+
"connectStreamWebsocket",
|
|
10068
|
+
"fetchMessages",
|
|
10069
|
+
"fetchNotificationPreferences",
|
|
10070
|
+
"flushCacheWalletAliases",
|
|
10071
|
+
"getConnectedClients",
|
|
10072
|
+
"getHolderCount",
|
|
10073
|
+
"getHolderHistory",
|
|
10074
|
+
"getHolderRank",
|
|
10075
|
+
"getHoldersByBalance",
|
|
10076
|
+
"getTopHolders",
|
|
10077
|
+
"getTrades",
|
|
10078
|
+
"registerPushToken",
|
|
10079
|
+
"removeContentReaction",
|
|
10080
|
+
"sendStreamChatViaWebSocket",
|
|
10081
|
+
"sendStreamReaction",
|
|
10082
|
+
"sendTypingIndicator",
|
|
10083
|
+
"unregisterPushToken",
|
|
10084
|
+
"updateNotificationPreferences"
|
|
10046
10085
|
]
|
|
10047
10086
|
},
|
|
10048
10087
|
"explainSdkTeacher": {
|
|
@@ -10072,6 +10111,7 @@
|
|
|
10072
10111
|
"fetch-dex-leaderboard-by-season-id",
|
|
10073
10112
|
"fetch-dex-pools",
|
|
10074
10113
|
"fetch-pools",
|
|
10114
|
+
"gdex-stream",
|
|
10075
10115
|
"global-bans",
|
|
10076
10116
|
"global-feed-subscription",
|
|
10077
10117
|
"graduation-detection",
|
|
@@ -10116,7 +10156,7 @@
|
|
|
10116
10156
|
"weekly-challenge",
|
|
10117
10157
|
"wrap-unwrap-operations"
|
|
10118
10158
|
],
|
|
10119
|
-
"topicCount":
|
|
10159
|
+
"topicCount": 65,
|
|
10120
10160
|
"methodCount": 317,
|
|
10121
10161
|
"exampleUsage": "gala_launchpad_explain_sdk_usage({ topic: \"buy-tokens\" })"
|
|
10122
10162
|
},
|