Skip to main content

Class: LaunchpadSDK

Gala Launchpad SDK 9.0.0-rc.5

Gala Launchpad SDK 9.0.0-rc.5 / index / LaunchpadSDK

Class: LaunchpadSDK

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:350

Constructors​

Constructor​

new LaunchpadSDK(config): LaunchpadSDK

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:432

Parameters​

config​

LaunchpadSDKConfig

Returns​

LaunchpadSDK

Address Management​

getAddress()​

getAddress(): AddressFormat

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:473

Gets the authenticated user's address in backend format

Returns the wallet address formatted for backend API calls. The backend expects addresses in the format "eth|{40-hex-chars}" without the standard "0x" prefix.

Returns​

AddressFormat

The address in eth|{40-hex-chars} format required by the backend

Since​

1.0.0

Throws​

ValidationError if wallet is not configured

Examples​

Get backend address format

const sdk = new LaunchpadSDK({ wallet });
const backendAddress = sdk.getAddress();
console.log(backendAddress); // "eth|742d35Cc6634C0532925a3b8D0Ea2c76f94C31C0"

Use in API calls

const address = sdk.getAddress();
const pools = await sdk.launchpad.fetchPools({
  creatorAddress: address,
  pageSize: 10
});

See​

getEthereumAddress - Get standard Ethereum address format

getEthereumAddress()​

getEthereumAddress(): string

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:505

Gets the authenticated user's Ethereum address in standard format

Returns the wallet address in standard Ethereum format with "0x" prefix. This is the format typically used in frontend displays and external tools.

Returns​

string

Standard Ethereum address with 0x prefix

Since​

1.0.0

Throws​

ValidationError if wallet is not configured

Examples​

Display user address

const sdk = new LaunchpadSDK({ wallet });
const ethAddress = sdk.getEthereumAddress();
console.log(`User: ${ethAddress}`); // "User: 0x742d35Cc6634C0532925a3b8D0Ea2c76f94C31C0"

Address consistency check

const ethAddr = sdk.getEthereumAddress();
const backendAddr = sdk.getAddress();

// Verify they represent the same address
const ethHex = stripHexPrefix(ethAddr);
const backendHex = backendAddr.replace('eth|', '');
console.log('Same address:', ethHex.toLowerCase() === backendHex.toLowerCase());

See​

getAddress - Get backend-compatible address format

AIModeration​

getAIModeration()​

getAIModeration(options): Promise<GetAIModerationResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5036

Get AI moderation for a specific content flag (overseer only).

Retrieves the AI moderation results for flagged content, including:

  • Recommendation (NO_ACTION, REVIEW_REQUIRED, DELETE_CONTENT, BAN_USER)
  • Confidence score (0-1)
  • Detected categories with individual confidence scores
  • Summary and reasoning for the recommendation
  • Tiered analysis metadata (tier used, escalation info, token usage)

Requires either Admin API key or JWT with overseer status.

Parameters​

options​

GetAIModerationOptions

Options including flagId

Returns​

Promise<GetAIModerationResult>

AI moderation data

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Throws​

Error if moderation not found (404)

Since​

6.15.0

Example​

const { moderation } = await sdk.getAIModeration({ flagId: 123 });

console.log('Status:', moderation.status);
console.log('Recommendation:', moderation.recommendation);
console.log('Confidence:', moderation.confidence);

// Tiered analysis info
if (moderation.analysisTier) {
  console.log('Tier used:', moderation.analysisTier);
  console.log('Escalated:', moderation.escalatedFromQuick);
}

getAIModerationSettings()​

getAIModerationSettings(): Promise<GetAIModerationSettingsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4969

Get current AI moderation settings (overseer only).

Returns configuration for AI-powered content moderation including:

  • Whether AI moderation is enabled
  • Moderation mode (DISABLED, ADVISORY)
  • Provider configuration
  • Tiered analysis settings (frames, resolution, escalation threshold)

Requires either Admin API key or JWT with overseer status.

Returns​

Promise<GetAIModerationSettingsResult>

AI moderation settings

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

6.15.0

Example​

const { settings } = await sdk.getAIModerationSettings();
console.log('AI enabled:', settings.enabled);
console.log('Mode:', settings.mode);
console.log('Tiered analysis:', settings.tieredAnalysisEnabled);
console.log('Quick scan frames:', settings.quickScanFrames);

getAIModerationStatus()​

getAIModerationStatus(): Promise<GetAIModerationStatusResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5106

Get AI system status (overseer only).

Returns the current status of the AI moderation system:

  • Whether AI is enabled globally
  • Current mode (DISABLED, ADVISORY)
  • Provider availability (e.g., Claude API accessible)

Useful for checking if AI moderation is operational before triggering moderation for flagged content.

Requires either Admin API key or JWT with overseer status.

Returns​

Promise<GetAIModerationStatusResult>

AI system status

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

6.15.0

Example​

const { status } = await sdk.getAIModerationStatus();

console.log('AI enabled:', status.enabled);
console.log('Provider available:', status.providerAvailable);

// Only trigger moderation if system is operational
if (status.enabled && status.providerAvailable) {
  await sdk.triggerAIModeration({ flagId: 123 });
}

triggerAIModeration()​

triggerAIModeration(options): Promise<TriggerAIModerationResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5073

Trigger AI moderation for a content flag (overseer only).

Queues flagged content for AI moderation. Moderation runs asynchronously - use getAIModeration() to poll for results or listen for the AI_MODERATION_COMPLETE WebSocket event.

For video content with tiered analysis enabled:

  • Quick scan runs first (5 frames at 480px)
  • If concerns found, detailed scan runs (20 frames at 640px)

Requires either Admin API key or JWT with overseer status.

Parameters​

options​

TriggerAIModerationOptions

Options including flagId

Returns​

Promise<TriggerAIModerationResult>

Queued status and message

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Throws​

Error if flag not found (404) or moderation already exists (400)

Since​

6.15.0

Example​

const result = await sdk.triggerAIModeration({ flagId: 123 });
console.log('Queued:', result.queued);

// Poll for results
let moderation;
while (!moderation || moderation.status === 'PROCESSING') {
  await new Promise(r => setTimeout(r, 1000));
  const result = await sdk.getAIModeration({ flagId: 123 });
  moderation = result.moderation;
}
console.log('Done:', moderation.recommendation);

updateAIModerationSettings()​

updateAIModerationSettings(options): Promise<UpdateAIModerationSettingsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5000

Update AI moderation settings (overseer only).

Configure AI-powered content moderation behavior. Only provided fields will be updated.

Requires either Admin API key or JWT with overseer status.

Parameters​

options​

UpdateAIModerationSettingsOptions

Settings to update

Returns​

Promise<UpdateAIModerationSettingsResult>

Updated AI moderation settings

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

6.15.0

Examples​

Enable AI moderation in advisory mode

const { settings } = await sdk.updateAIModerationSettings({
  enabled: true,
  mode: 'ADVISORY'
});

Change provider

const { settings } = await sdk.updateAIModerationSettings({
  provider: 'claude'
});

Authentication​

ensureValidToken()​

ensureValidToken(thresholdMs?): Promise<string>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2747

Ensure we have a valid token, refreshing if necessary.

Call this before making authenticated requests to ensure the token won't expire mid-request. Will:

  • Throw if not authenticated at all
  • Re-login if token is expired
  • Refresh if token expires within threshold
  • Return current token if still valid

Parameters​

thresholdMs?​

number

Refresh threshold in milliseconds (default: 5 minutes)

Returns​

Promise<string>

Current access token

Throws​

Error if not authenticated and can't refresh

Since​

5.2.0

Example​

Before critical operation

const token = await sdk.ensureValidToken();
// Token is guaranteed valid for at least 5 more minutes
await criticalStreamingOperation();

getAccessToken()​

getAccessToken(): string | null

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2722

Get the current JWT access token.

Returns the raw token string for use in custom requests or debugging. Returns null if not authenticated.

Returns​

string | null

Access token string, or null if not authenticated

Since​

5.2.0

Example​

Use token in custom request

const token = sdk.getAccessToken();
if (token) {
  const headers = { 'Authorization': `Bearer ${token}` };
  // Use headers in custom fetch call
}

getSession()​

getSession(): Promise<SessionInfo>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2701

Get current session information from the backend.

Returns session details including:

  • Authenticated address
  • Token issued time
  • Token expiration time

Returns​

Promise<SessionInfo>

Session info with address and timestamps

Throws​

Error if not authenticated

Since​

5.2.0

Example​

View session details

const session = await sdk.getSession();
console.log(`Logged in as: ${session.address}`);
console.log(`Session expires: ${session.expiresAt}`);

isAuthenticated()​

isAuthenticated(): boolean

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2657

Check if user is authenticated with valid JWT.

Returns true if:

  • A JWT token exists
  • The token has not expired

Returns​

boolean

true if authenticated with non-expired token

Since​

5.2.0

Example​

Check authentication status

if (!sdk.isAuthenticated()) {
  await sdk.login();
}
// Now proceed with authenticated operations

login()​

login(): Promise<LoginResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2551

Login with wallet signature to get JWT token.

This authenticates the user with the backend by:

  1. Generating a message with timestamp: "Sign in to Launchpad t:{timestamp}"
  2. Signing the message with the configured wallet
  3. Sending the signature to the backend for verification
  4. Storing the returned JWT token for authenticated requests

Required before calling JWT-protected endpoints:

  • startStream(), stopStream(), resetStreamKey(), getRecordingDownload(), deleteRecording()
  • addSimulcastTarget(), removeSimulcastTarget()
  • sendChatMessage() (REST API)

Returns​

Promise<LoginResponse>

Login response with accessToken and expiration

Throws​

Error if wallet is not configured

Throws​

Error if signature fails

Since​

5.2.0

Examples​

Basic login

const { accessToken, expiresIn, address } = await sdk.login();
console.log(`Logged in as ${address}`);
console.log(`Token expires in ${expiresIn}s`);

Login before streaming

// Authenticate first
await sdk.login();

// Now streaming methods work
const stream = await sdk.startStream('mytoken');

loginWithDevBypass()​

loginWithDevBypass(address): Promise<LoginResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2580

Log in as address without a signature: the backend's development bypass, accepted by non-production deployments only. Session handling as in loginWithSignature.

Parameters​

address​

string

Returns​

Promise<LoginResponse>

Since​

9.0.0

loginWithSignature()​

loginWithSignature(request): Promise<LoginResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2572

Log in with a signature the caller made: a browser wallet signs the login message (Sign in to Launchpad t:<ms>, JWT_CONSTANTS) itself, so an SDK built with only a signer has nothing to sign it with. publicKey registers a client| alias's key.

With an app session the login asks for a cookie session (the refresh token becomes an httpOnly cookie and is absent from the answer) and nothing is stored in the SDK: hand the answer to the session. Without one the tokens are stored as login stores them. A failure is an AuthError carrying the backend's statusCode.

Parameters​

request​

LoginRequest

Returns​

Promise<LoginResponse>

Since​

9.0.0

Example​

const message = `Sign in to Launchpad t:${Date.now()}`;
const signature = await provider.signMessage(message);
const { accessToken, refreshExpiresIn } = await sdk.loginWithSignature({ address, message, signature });

logout()​

logout(options?): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2633

Logout and clear the JWT token.

Clears the client-side JWT and optionally revokes all active sessions on the server. Future calls to JWT-protected endpoints will fail until login() is called again.

Parameters​

options?​

Optional logout configuration

accessToken?​

string | null

allDevices?​

boolean

If true, revokes all active sessions server-side (requires valid JWT)

Returns​

Promise<void>

Promise that resolves when logout is complete

Since​

5.2.0

Examples​

Clean logout

// ... do work ...
await sdk.logout();
console.log('Logged out');

Logout from all devices

await sdk.logout({ allDevices: true });
console.log('Logged out from all devices');

With an app session the logout always reaches the server (POST /auth/logout, the cookie naming the session to revoke), carries options.accessToken as its bearer when given, and throws an AuthError (with the backend's statusCode) when it fails.

refreshToken()​

refreshToken(): Promise<LoginResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2602

Refresh the current JWT token.

Use this to get a new token before the current one expires. The token is automatically refreshed during requests if it will expire within 5 minutes.

Returns​

Promise<LoginResponse>

Refresh response with new accessToken

Throws​

Error if not authenticated (call login() first)

Since​

5.2.0

Example​

Manual token refresh

if (sdk.shouldRefreshToken()) {
  const { accessToken, expiresIn } = await sdk.refreshToken();
  console.log(`Token refreshed, expires in ${expiresIn}s`);
}

shouldRefreshToken()​

shouldRefreshToken(thresholdMs?): boolean

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2679

Check if token should be refreshed.

Returns true if token exists and will expire within the threshold. Default threshold is 5 minutes.

Parameters​

thresholdMs?​

number

Custom threshold in milliseconds (default: 5 minutes)

Returns​

boolean

true if refresh is recommended

Since​

5.2.0

Example​

Check before long operation

// Ensure token won't expire during operation
if (sdk.shouldRefreshToken(10 * 60 * 1000)) { // 10 minutes
  await sdk.refreshToken();
}
await performLongOperation();

Bridge​

bridgeIn()​

bridgeIn(params): Promise<BridgeTransaction>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7179

Bridge tokens from an external chain to GalaChain.

Initiates a cross-chain transfer from Ethereum or Solana to GalaChain. The transfer will burn wrapped tokens on the source chain and unlock tokens on GalaChain.

Parameters​

params​

BridgeInParams

Bridge in parameters

Returns​

Promise<BridgeTransaction>

Promise resolving to transaction details

Throws​

Error if wallet is not configured

Throws​

Error if token is not bridgeable from the source chain

Since​

4.0.16

Example​

Bridge GALA from Ethereum to GalaChain

const result = await sdk.bridgeIn({
  tokenId: 'GALA|Unit|none|none',
  amount: '100',
  sourceChain: 'Ethereum',
});
console.log(`Transaction: ${result.transactionHash}`);

bridgeOut()​

bridgeOut(params): Promise<BridgeTransaction>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7153

Bridge tokens from GalaChain to an external chain.

Initiates a cross-chain transfer from GalaChain to Ethereum or Solana. The transfer will lock tokens on GalaChain and mint wrapped tokens on the destination chain.

Parameters​

params​

BridgeOutParams

Bridge out parameters

Returns​

Promise<BridgeTransaction>

Promise resolving to transaction details

Throws​

Error if wallet is not configured

Throws​

Error if token is not bridgeable to the destination chain

Throws​

Error if recipient address is invalid

Since​

4.0.16

Example​

Bridge GALA to Ethereum

const result = await sdk.bridgeOut({
  tokenId: 'GALA|Unit|none|none',
  amount: '100',
  destinationChain: 'Ethereum',
  recipientAddress: '0x1234...abcd',
});
console.log(`Transaction: ${result.transactionHash}`);

estimateBridgeFee()​

estimateBridgeFee(params): Promise<BridgeFeeEstimate>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7125

Estimate bridge fees for a cross-chain transfer.

Calculates the expected fees for bridging tokens from GalaChain to an external chain (Ethereum or Solana).

Parameters​

params​

EstimateBridgeFeeParams

Fee estimation parameters

Returns​

Promise<BridgeFeeEstimate>

Promise resolving to fee estimate with breakdown

Throws​

Error if wallet is not configured

Throws​

Error if token is not bridgeable to the destination chain

Since​

4.0.16

Example​

Estimate fee for bridging GALA to Ethereum

// the fee does not depend on the amount bridged
const fee = await sdk.estimateBridgeFee({
  tokenId: 'GALA|Unit|none|none',
  destinationChain: 'Ethereum',
});
console.log(`Fee: ${fee.estimatedFeeInGala} GALA`);

fetchAllBridgeableTokensByNetwork()​

fetchAllBridgeableTokensByNetwork(network): Promise<FetchBridgeableTokensResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2134

Fetch ALL bridgeable tokens for a network with auto-pagination

Automatically handles pagination to retrieve all tokens bridgeable to the specified network. Returns cached data if available; fetches from API otherwise.

Parameters​

network​

BridgeableNetwork

Target network ('ETHEREUM' or 'SOLANA')

Returns​

Promise<FetchBridgeableTokensResult>

Promise resolving to all bridgeable tokens for the network

Throws​

NetworkError if DEX API is unavailable

Since​

3.33.0

Example​

Fetch all Ethereum-bridgeable tokens

const result = await sdk.fetchAllBridgeableTokensByNetwork('ETHEREUM');
console.log(`Total: ${result.tokenCount} tokens`);
result.tokens.forEach(t => {
  console.log(`${t.symbol}: ${t.ethereumContractAddress}`);
});

fetchAllTokensBridgeableToEthereum()​

fetchAllTokensBridgeableToEthereum(): Promise<FetchBridgeableTokensResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2156

Fetch all tokens bridgeable to Ethereum

Convenience method for fetching Ethereum-bridgeable tokens. Returns cached data if available; fetches from API otherwise.

Returns​

Promise<FetchBridgeableTokensResult>

Promise resolving to all Ethereum-bridgeable tokens

Throws​

NetworkError if DEX API is unavailable

Since​

3.33.0

Example​

Get Ethereum-bridgeable tokens

const result = await sdk.fetchAllTokensBridgeableToEthereum();
console.log('Ethereum-bridgeable tokens:');
result.tokens.forEach(t => {
  console.log(`  ${t.symbol}: ${t.ethereumContractAddress}`);
});

fetchAllTokensBridgeableToSolana()​

fetchAllTokensBridgeableToSolana(): Promise<FetchBridgeableTokensResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2178

Fetch all tokens bridgeable to Solana

Convenience method for fetching Solana-bridgeable tokens. Returns cached data if available; fetches from API otherwise.

Returns​

Promise<FetchBridgeableTokensResult>

Promise resolving to all Solana-bridgeable tokens

Throws​

NetworkError if DEX API is unavailable

Since​

3.33.0

Example​

Get Solana-bridgeable tokens

const result = await sdk.fetchAllTokensBridgeableToSolana();
console.log('Solana-bridgeable tokens:');
result.tokens.forEach(t => {
  console.log(`  ${t.symbol}: ${t.solanaContractAddress}`);
});

fetchBridgeableTokensByNetwork()​

fetchBridgeableTokensByNetwork(options): Promise<FetchBridgeableTokensResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2111

Fetch bridgeable tokens for a specific network with pagination

Queries the DEX API to discover which tokens can be bridged to the specified network. Results are cached permanently for the SDK lifetime (bridgeable tokens never change).

Parameters​

options​

FetchBridgeableTokensOptions

Fetch options including network and pagination

Returns​

Promise<FetchBridgeableTokensResult>

Promise resolving to paginated bridgeable tokens

Throws​

NetworkError if DEX API is unavailable

Since​

3.33.0

Example​

Paginated fetch for Ethereum

const result = await sdk.fetchBridgeableTokensByNetwork({
  network: 'ETHEREUM',
  pageSize: 100
});
console.log(`Found ${result.tokenCount} Ethereum-bridgeable tokens`);

getBridgeStatus()​

getBridgeStatus(transactionHash): Promise<BridgeStatus>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7197

Get the status of a bridge transaction.

Checks the current status of a cross-chain bridge transaction.

Parameters​

transactionHash​

string

Transaction hash to check (one GalaConnect status read, any chain)

Returns​

Promise<BridgeStatus>

Promise resolving to bridge status

Since​

4.0.16

Example​

Check bridge status

const status = await sdk.getBridgeStatus('0x1234...abcd');
console.log(`Status: ${status.status}`);

getSupportedBridgeTokens()​

getSupportedBridgeTokens(): Promise<{ supportedChains: string[]; tokens: BridgeToken[]; totalCount: number; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7217

Get list of tokens supported for bridging.

Returns the static list of tokens that can be bridged between GalaChain and external chains.

Returns​

Promise<{ supportedChains: string[]; tokens: BridgeToken[]; totalCount: number; }>

Promise resolving to supported bridge tokens

Since​

4.0.16

Example​

Get supported tokens

const tokens = await sdk.getSupportedBridgeTokens();
tokens.tokens.forEach(t => {
  console.log(`${t.symbol}: ${t.supportedChains.join(', ')}`);
});

isTokenBridgeableToEthereum()​

isTokenBridgeableToEthereum(tokenId): Promise<IsTokenBridgeableResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2239

Check if a token is bridgeable to Ethereum

Convenience method for checking Ethereum bridgeability. Returns contract address if token is bridgeable.

Parameters​

tokenId​

TokenId

Token identifier (pipe-delimited string or TokenClassKey object)

Returns​

Promise<IsTokenBridgeableResult>

Promise resolving to bridgeability check result

Throws​

NetworkError if DEX API is unavailable

Throws​

ValidationError if tokenId format is invalid

Since​

3.33.0

Example​

Check if GWETH is bridgeable to Ethereum

// Pipe-delimited format
const result = await sdk.isTokenBridgeableToEthereum('Token|Unit|GWETH|eth:0x...');
console.log(`Bridgeable: ${result.isBridgeable}`);

// Or TokenClassKey object
const result = await sdk.isTokenBridgeableToEthereum({
  collection: 'Token', category: 'Unit', type: 'GWETH', additionalKey: 'eth:0x...'
});

isTokenBridgeableToNetwork()​

isTokenBridgeableToNetwork(options): Promise<IsTokenBridgeableResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2212

Check if a token is bridgeable to a specific network

Returns bridgeability status and contract address if available. Uses cached data for efficient lookups; fetches from API if not cached.

Parameters​

options​

IsTokenBridgeableOptions

Token identifier and target network

Returns​

Promise<IsTokenBridgeableResult>

Promise resolving to bridgeability check result

Throws​

NetworkError if DEX API is unavailable

Throws​

ValidationError if tokenId format is invalid

Since​

3.33.0

Examples​

Check GALA bridgeability with pipe-delimited format

const result = await sdk.isTokenBridgeableToNetwork({
  tokenId: 'GALA|Unit|none|none',
  network: 'ETHEREUM'
});
if (result.isBridgeable) {
  console.log(`GALA contract: ${result.contractAddress}`);
}

Check with TokenClassKey object

const result = await sdk.isTokenBridgeableToNetwork({
  tokenId: { collection: 'Token', category: 'Unit', type: 'GALA', additionalKey: 'none' },
  network: 'SOLANA'
});

isTokenBridgeableToSolana()​

isTokenBridgeableToSolana(tokenId): Promise<IsTokenBridgeableResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2266

Check if a token is bridgeable to Solana

Convenience method for checking Solana bridgeability. Returns contract address if token is bridgeable.

Parameters​

tokenId​

TokenId

Token identifier (pipe-delimited string or TokenClassKey object)

Returns​

Promise<IsTokenBridgeableResult>

Promise resolving to bridgeability check result

Throws​

NetworkError if DEX API is unavailable

Throws​

ValidationError if tokenId format is invalid

Since​

3.33.0

Example​

Check if GALA is bridgeable to Solana

// Pipe-delimited format
const result = await sdk.isTokenBridgeableToSolana('GALA|Unit|none|none');
console.log(`Bridgeable: ${result.isBridgeable}`);

// Or TokenClassKey object
const result = await sdk.isTokenBridgeableToSolana({
  collection: 'Token', category: 'Unit', type: 'GALA', additionalKey: 'none'
});

Cache Management​

clearCache()​

clearCache(tokenName?): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8882

Clear token caches

Clears cached token data. Can clear a specific launchpad token or all caches. When clearing all (no tokenName provided), also clears bridgeable and wrappable token caches. Useful for testing or when you need to force a fresh fetch of token data.

Note: Caches automatically warm from fetchPools/fetchBridgeableTokens/fetchWrappableTokens calls and persist across the entire SDK/MCP session lifetime.

Parameters​

tokenName?​

string

Optional launchpad token name to clear (clears all caches if not provided)

Returns​

void

Since​

3.9.2

Examples​

Clear specific launchpad token

sdk.clearCache('anime'); // Clear only anime token metadata

Clear all caches (launchpad metadata + bridgeable + wrappable tokens)

sdk.clearCache(); // Clear all cached token data

flushAllCache()​

flushAllCache(confirm): Promise<FlushResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4576

Flush ALL Launchpad cache (Nuclear Option).

Clears ALL cached data across the entire Launchpad platform including:

  • All user profile data
  • All token data (chat, recordings, holders, prices)
  • All overseer/moderator access data
  • All ban status data
  • Site configuration cache

WARNING: This will cause a temporary performance hit across the entire platform as all data needs to be re-fetched from the database.

Requires Admin API key OR JWT as existing Overseer. Safety feature: Requires confirm=true to prevent accidental usage.

Parameters​

confirm​

true

Must be true to proceed (safety confirmation)

Returns​

Promise<FlushResult>

Flush result with count and duration

Throws​

ValidationError if confirm is not true

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

8.x.0

Example​

Flush all cache (dangerous!)

const result = await sdk.flushAllCache(true);
console.log(`Flushed ALL ${result.flushedCount} cache entries in ${result.duration}ms`);

flushCacheByAddress()​

flushCacheByAddress(address): Promise<FlushResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4519

Flush all cache entries for a wallet address.

Clears cached data associated with the specified address including:

  • User profile data (profile:data:, profile:stats:)
  • Overseer status
  • Owned tokens list
  • Ban status (global and per-token)

Requires Admin API key OR JWT as existing Overseer.

Parameters​

address​

string

Wallet address to flush cache for (eth|... or 0x... format)

Returns​

Promise<FlushResult>

Flush result with count and duration

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

8.x.0

Example​

Flush cache for a user

const result = await sdk.flushCacheByAddress('eth|abc123...');
console.log(`Flushed ${result.flushedCount} cache entries in ${result.duration}ms`);

flushCacheByToken()​

flushCacheByToken(tokenName): Promise<FlushResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4545

Flush all cache entries for a token.

Clears cached data associated with the specified token including:

  • Stream chat messages and pinned messages
  • Recordings list
  • Holders data and rankings
  • Token ban status
  • Price data (GALA and USD)

Requires Admin API key OR JWT as existing Overseer.

Parameters​

tokenName​

string

Token name to flush cache for

Returns​

Promise<FlushResult>

Flush result with count and duration

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

8.x.0

Example​

Flush cache for a token

const result = await sdk.flushCacheByToken('MYTOKEN');
console.log(`Flushed ${result.flushedCount} cache entries in ${result.duration}ms`);

flushWalletAliasCache()​

flushWalletAliasCache(address?): Promise<FlushResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4609

Flush wallet-alias cache entries.

Clears the cached eth| → client| alias resolution for the given address, or ALL wallet-alias entries if no address is provided.

Use this when a user's login returns a stale eth| address even though they have a client| alias on GalaChain. After flushing, the next login will re-resolve the alias from the GalaChain public-key contract.

Requires Admin API key OR JWT as existing Overseer.

Parameters​

address?​

string

Optional. Wallet address (eth| or 0x format) to flush. If omitted, ALL wallet-alias entries are flushed.

Returns​

Promise<FlushResult>

Flush result with count and duration

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

8.x.0

Examples​

Flush alias for a single address

const result = await sdk.flushWalletAliasCache('eth|dc1783...');
console.log(`Flushed ${result.flushedCount} alias entries in ${result.duration}ms`);

Flush all wallet alias entries

const result = await sdk.flushWalletAliasCache();
console.log(`Flushed ${result.flushedCount} alias entries in ${result.duration}ms`);

getCacheInfo()​

getCacheInfo(): object

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8843

Get token metadata cache information

Returns statistics about all token caches including:

  • Launchpad token metadata cache (totalTokens, cacheSize, oldestEntry)
  • Bridgeable token cache (bridgeableTokens - by network)
  • Wrappable token cache (wrappableTokens - count and timestamp)

Caches persist for the entire SDK/MCP server lifetime and accumulate data across conversations for optimal performance.

Returns​

object

Cache statistics object with launchpad, bridgeable, and wrappable token stats

bridgeableTokens?​

optional bridgeableTokens?: object

bridgeableTokens.ETHEREUM​

ETHEREUM: number

bridgeableTokens.SOLANA​

SOLANA: number

bridgeableTokens.total​

total: number

cacheSize​

cacheSize: number

oldestEntry​

oldestEntry: number

totalTokens​

totalTokens: number

wrappableTokens?​

optional wrappableTokens?: object

wrappableTokens.isPopulated​

isPopulated: boolean

wrappableTokens.lastFetchedAt​

lastFetchedAt: number | null

wrappableTokens.tokenCount​

tokenCount: number

Since​

3.9.2

Example​

const cacheInfo = sdk.getCacheInfo();
console.log(`Launchpad tokens: ${cacheInfo.totalTokens}`);
console.log(`Cache size: ${cacheInfo.cacheSize} bytes`);
console.log(`Bridgeable ETH: ${cacheInfo.bridgeableTokens?.ETHEREUM ?? 0}`);
console.log(`Bridgeable SOL: ${cacheInfo.bridgeableTokens?.SOLANA ?? 0}`);
console.log(`Wrappable tokens: ${cacheInfo.wrappableTokens?.tokenCount ?? 0}`);

Calculations​

calculateBuyAmount()​

calculateBuyAmount(options): Promise<AmountCalculationResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7379

Calculate buy amount for a token purchase with automatic mode selection

Flexible calculation method that automatically routes to either local (instant, client-side) or external (real-time, GalaChain) calculation based on available parameters. Defaults to external calculation for guaranteed accuracy unless currentSupply is provided.

Supports two calculation types:

  • type: 'native' - Calculate tokens received for a given GALA amount
  • type: 'exact' - Calculate GALA needed to buy a specific token amount

Parameters​

options​

CalculateBuyAmountOptions

Calculation options with required tokenName and amount

Returns​

Promise<AmountCalculationResult>

Promise Calculated amount with fees breakdown

Throws​

If tokenName or amount is invalid

Throws​

If external calculation fails

Since​

1.0.0

Examples​

Calculate tokens from GALA (external mode)

const result = await sdk.calculateBuyAmount({
  tokenName: 'anime',
  amount: '100',      // 100 GALA
  type: 'native'
});
console.log('Tokens you will receive:', result.amount);
console.log('Transaction fee:', result.transactionFee);

Calculate GALA needed for tokens (external mode)

const result = await sdk.calculateBuyAmount({
  tokenName: 'anime',
  amount: '1000',     // 1000 tokens
  type: 'exact'
});
console.log('GALA needed:', result.amount);
console.log('Fees:', result.transactionFee, result.gasFee);

Performance-optimized with local calculation

// Fetch supply once, reuse for multiple calculations
const poolDetails = await sdk.fetchPoolDetailsForCalculation('anime');

const calc1 = await sdk.calculateBuyAmount({
  tokenName: 'anime',
  amount: '100',
  type: 'native',
  currentSupply: poolDetails.currentSupply  // Enables instant local calculation
});

const calc2 = await sdk.calculateBuyAmount({
  tokenName: 'anime',
  amount: '500',
  type: 'native',
  currentSupply: poolDetails.currentSupply  // Reuse same supply
});

calculateInitialBuyAmount()​

calculateInitialBuyAmount(nativeTokenQuantity): Promise<AmountCalculationResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7684

Calculate initial buy amount for pre-mint token launches

Calculates the number of tokens that will be received when purchasing during the token launch pre-buy phase. This is used internally during token creation with the preBuyQuantity parameter.

The pre-mint phase uses the same exponential bonding curve formula but starts from zero supply, providing the best possible price for early supporters.

Parameters​

nativeTokenQuantity​

string

Amount of GALA to spend during pre-buy (decimal string)

Returns​

Promise<AmountCalculationResult>

Promise Calculated tokens with fee breakdown

Throws​

If nativeTokenQuantity is invalid or negative

Throws​

If API request fails

Since​

1.0.0

Examples​

Calculate pre-buy tokens

const result = await sdk.calculateInitialBuyAmount('100');
console.log('Tokens from 100 GALA pre-buy:', result.amount);
console.log('Transaction fee:', result.transactionFee);
console.log('Starting supply:', result.currentSupply); // Should be "0"

Validate pre-buy before launch

// Check what you'll receive before launching token
const preBuyAmount = '50'; // 50 GALA
const calc = await sdk.calculateInitialBuyAmount(preBuyAmount);

console.log(`Pre-buying with ${preBuyAmount} GALA will give you ${calc.amount} tokens`);

// Now launch with this pre-buy amount
const launch = await sdk.launchToken({
  tokenName: 'mytoken',
  tokenSymbol: 'MTK',
  tokenDescription: 'My token',
  preBuyQuantity: preBuyAmount
});

calculateSellAmount()​

calculateSellAmount(options): Promise<AmountCalculationResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7445

Calculate sell amount for a token sale with automatic mode selection

Flexible calculation method that automatically routes to either local (instant, client-side) or external (real-time, GalaChain) calculation based on available parameters. Defaults to external calculation for guaranteed accuracy unless currentSupply and RBC fees are provided.

Supports two calculation types:

  • type: 'exact' - Calculate GALA received for selling a specific token amount
  • type: 'native' - Calculate tokens needed to receive a specific GALA amount

Includes reverse bonding curve (RBC) fee calculation that scales with token supply.

Parameters​

options​

CalculateSellAmountOptions

Calculation options with required tokenName and amount

Returns​

Promise<AmountCalculationResult>

Promise Calculated amount with fees breakdown including RBC fee

Throws​

If tokenName or amount is invalid

Throws​

If external calculation fails

Since​

1.0.0

Examples​

Calculate GALA from selling tokens (external mode)

const result = await sdk.calculateSellAmount({
  tokenName: 'anime',
  amount: '500',      // 500 tokens
  type: 'exact'
});
console.log('GALA you will receive:', result.amount);
console.log('Reverse bonding fee:', result.reverseBondingCurveFee);
console.log('Transaction fee:', result.transactionFee);

Calculate tokens needed for GALA (external mode)

const result = await sdk.calculateSellAmount({
  tokenName: 'anime',
  amount: '50',       // 50 GALA desired
  type: 'native'
});
console.log('Tokens to sell:', result.amount);
console.log('Total fees deducted:', result.totalFees);

Performance-optimized with local calculation

// Fetch pool details once, reuse for multiple calculations
const poolDetails = await sdk.fetchPoolDetailsForCalculation('anime');

const calc1 = await sdk.calculateSellAmount({
  tokenName: 'anime',
  amount: '500',
  type: 'exact',
  currentSupply: poolDetails.currentSupply,
  reverseBondingCurveMaxFeeFactor: poolDetails.reverseBondingCurveMaxFeeFactor,
  reverseBondingCurveMinFeeFactor: poolDetails.reverseBondingCurveMinFeeFactor
});
// Instant local calculation - no network calls

Chat​

deleteChatMessage()​

deleteChatMessage(id): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5738

Delete a chat message.

Supports both JWT and API key authentication. Authorization: message author, pool owner, or MANAGE_CHAT permission.

Parameters​

id​

string

Message ID to delete (format: chat-{timestamp}-{uuid})

Returns​

Promise<void>

Throws​

ValidationError if ID format is invalid

Throws​

ConfigurationError if neither JWT nor API key is configured

Since​

6.2.0

Example​

Delete a chat message

await sdk.deleteChatMessage('chat-1734445623456-550e8400-e29b-41d4-a716-446655440000');
console.log('Message deleted');

disableChat()​

disableChat(tokenName): Promise<ChatStatusResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3204

Disable chat for a specific token.

Supports dual authentication:

  • Admin (API key): Sets ADMIN_DISABLED - owner locked out
  • Owner (JWT): Sets DISABLED - owner can re-enable

Parameters​

tokenName​

string

Token name (lowercase)

Returns​

Promise<ChatStatusResponse>

Promise resolving with enabled status and detailed status

Throws​

Error if neither admin API key nor JWT is configured

Since​

5.1.0

Since​

5.4.0 - Added dual-auth support (Admin API key OR JWT owner)

enableChat()​

enableChat(tokenName): Promise<ChatStatusResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3221

Enable chat for a specific token.

Supports dual authentication:

  • Admin (API key): Sets ENABLED - clears lock, owner regains control
  • Owner (JWT): Sets ENABLED - fails with 403 if ADMIN_DISABLED

Parameters​

tokenName​

string

Token name (lowercase)

Returns​

Promise<ChatStatusResponse>

Promise resolving with enabled status and detailed status

Throws​

Error if neither admin API key nor JWT is configured

Throws​

Error (403) if owner tries to enable when ADMIN_DISABLED

Since​

5.1.0

Since​

5.4.0 - Added dual-auth support (Admin API key OR JWT owner)

getChatMessages()​

getChatMessages(options): Promise<GetChatMessagesResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5671

Get chat messages with optional filtering.

Public endpoint - no authentication required. At least one of tokenName or userAddress must be provided.

Parameters​

options​

GetChatMessagesOptions

Query options including tokenName/userAddress and pagination

Returns​

Promise<GetChatMessagesResult>

Paginated list of chat messages

Throws​

ValidationError if no filter is provided or options are invalid

Since​

6.2.0

Examples​

Get chat messages for a token

const { messages, meta } = await sdk.getChatMessages({ tokenName: 'anime' });
console.log(`Found ${meta.totalItems} messages`);
messages.forEach(msg => {
  console.log(`${msg.userProfile?.fullName}: ${msg.content}`);
});

Get chat messages by a user

const result = await sdk.getChatMessages({
  userAddress: 'eth|123...',
  pageSize: 50
});

getChatStatus()​

getChatStatus(tokenName): Promise<ChatStatusResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3188

The chat status of a token (GET /live/:tokenName/chat, public): whether chat is on, why it is off (reason: 'global' or 'token') and the slow-mode interval (slowModeSeconds, 0 = off).

Parameters​

tokenName​

string

Token name

Returns​

Promise<ChatStatusResponse>

The token's chat status

Throws​

ValidationError if the token name is invalid

Since​

9.0.0

Example​

const status = await sdk.getChatStatus('mytoken');
if (!status.enabled) console.log('Chat is off:', status.reason);
console.log('Slow mode:', status.slowModeSeconds ?? 0, 's');

getPinnedChatMessage()​

getPinnedChatMessage(tokenName): Promise<GetPinnedMessageResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3243

Get the currently pinned chat message for a token (v6.x.0+)

Retrieves the pinned message for a token's chat if one exists.

Parameters​

tokenName​

string

Token name (lowercase)

Returns​

Promise<GetPinnedMessageResult>

Pinned message details or null if no message is pinned

Throws​

If token name is invalid

Since​

6.x.0

Example​

Get pinned message

const pinned = await sdk.getPinnedChatMessage('mytoken');
if (pinned) {
  console.log('Pinned message:', pinned.content);
  console.log('Pinned by:', pinned.pinnedBy);
}

pinChatMessage()​

pinChatMessage(tokenName, messageId): Promise<GetPinnedMessageResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3266

Pin a chat message for a token (v6.x.0+)

Pins a message to the top of the chat for this token. Requires admin or manager access.

Parameters​

tokenName​

string

Token name (lowercase)

messageId​

string

ID of the message to pin

Returns​

Promise<GetPinnedMessageResult>

The token's pinned message as read back after the pin. pinnedMessage is null when another moderator unpinned it between the two requests.

Throws​

If token name or message ID is invalid

Throws​

If user is not authorized to pin messages

Since​

6.x.0

Example​

Pin a message

const result = await sdk.pinChatMessage('mytoken', 'msg123');
console.log('Message pinned:', result.pinnedMessage?.messageId);

sendChatMessage()​

sendChatMessage(options): Promise<CreateChatMessageResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5694

Send a chat message.

Requires JWT authentication.

Parameters​

options​

CreateChatMessageOptions

Send options including tokenName and content

Returns​

Promise<CreateChatMessageResult>

The created chat message

Throws​

ValidationError if token name or content is invalid

Throws​

ConfigurationError if JWT is not configured

Since​

6.2.0

Example​

Send a chat message

const result = await sdk.sendChatMessage({
  tokenName: 'anime',
  content: 'Hello everyone!'
});
console.log('Message sent:', result.message.id);

setSlowMode()​

setSlowMode(tokenName, slowModeSeconds): Promise<{ slowModeSeconds: number; tokenName: string; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3312

Set slow mode interval for a token's chat (v8.x.0+)

Throttles users to one message per N seconds. Enforcement is server-side (Redis-backed). Set to 0 to disable slow mode.

Parameters​

tokenName​

string

Token name (lowercase)

slowModeSeconds​

number

Interval in seconds (0 = disabled, max 600)

Returns​

Promise<{ slowModeSeconds: number; tokenName: string; }>

Updated slow mode setting

Throws​

If token name is invalid or seconds out of range

Since​

8.x.0

Examples​

Set 30-second slow mode

await sdk.setSlowMode('mytoken', 30);

Disable slow mode

await sdk.setSlowMode('mytoken', 0);

unpinChatMessage()​

unpinChatMessage(tokenName): Promise<UnpinMessageResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3286

Unpin the currently pinned chat message for a token (v6.x.0+)

Removes the pinned message from a token's chat. Requires admin or manager access.

Parameters​

tokenName​

string

Token name (lowercase)

Returns​

Promise<UnpinMessageResult>

Throws​

If token name is invalid

Throws​

If user is not authorized to unpin messages

Since​

6.x.0

Example​

Unpin a message

await sdk.unpinChatMessage('mytoken');
console.log('Message unpinned');

updateChatMessage()​

updateChatMessage(id, options): Promise<UpdateChatMessageResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5718

Update a chat message.

Requires JWT authentication. Only the message author can update.

Parameters​

id​

string

Message ID to update (format: chat-{timestamp}-{uuid})

options​

UpdateChatMessageOptions

Update options including new content

Returns​

Promise<UpdateChatMessageResult>

The updated chat message

Throws​

ValidationError if ID or content is invalid

Throws​

ConfigurationError if JWT is not configured

Since​

6.2.0

Example​

Update a chat message

const result = await sdk.updateChatMessage(
  'chat-1734445623456-550e8400-e29b-41d4-a716-446655440000',
  { content: 'Updated message' }
);
console.log('Updated:', result.message.updatedAt);

Comments​

createComment()​

createComment(options): Promise<CreateCommentResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5596

Create a new comment on a token pool.

Requires JWT authentication.

Parameters​

options​

CreateCommentOptions

Create options including tokenName and content

Returns​

Promise<CreateCommentResult>

The created comment

Throws​

ValidationError if token name or content is invalid

Throws​

ConfigurationError if JWT is not configured

Since​

6.2.0

Example​

Create a comment

const result = await sdk.createComment({
  tokenName: 'mytoken',
  content: 'This is a great project!'
});
console.log('Created comment ID:', result.comment.id);

deleteComment()​

deleteComment(id): Promise<DeleteCommentResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5640

Delete a comment.

Requires authentication (JWT or API key). Authorization: comment author, pool creator, moderator with MANAGE_COMMENTS permission, or overseer.

Parameters​

id​

string

Message ID of the comment to delete

Returns​

Promise<DeleteCommentResult>

Success indicator

Throws​

ValidationError if ID is invalid

Throws​

ConfigurationError if neither JWT nor API key is configured

Since​

6.2.0

Example​

Delete a comment

await sdk.deleteComment('msg-1234567890123-abc...');
console.log('Comment deleted');

getComments()​

getComments(options): Promise<CommentsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5573

Get comments with optional filtering.

Public endpoint - no authentication required. At least one of tokenName or userAddress must be provided.

Parameters​

options​

GetCommentsOptions

Query options including tokenName/userAddress and pagination

Returns​

Promise<CommentsResult>

Paginated list of comments

Throws​

ValidationError if no filter is provided or options are invalid

Since​

6.2.0

Examples​

Get comments for a token

const { messages, meta } = await sdk.getComments({ tokenName: 'mytoken' });
console.log(`Page ${meta.currentPage} of ${meta.totalPages}`);
messages.forEach(comment => {
  console.log(`${comment.userProfile?.fullName}: ${comment.content}`);
});

Get comments by a user

const result = await sdk.getComments({
  userAddress: 'eth|123...',
  pageSize: 20
});

updateComment()​

updateComment(id, options): Promise<UpdateCommentResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5619

Update a comment.

Requires JWT authentication. Only the comment author can update.

Parameters​

id​

string

Message ID of the comment to update

options​

UpdateCommentOptions

Update options including new content

Returns​

Promise<UpdateCommentResult>

The updated comment

Throws​

ValidationError if ID or content is invalid

Throws​

ConfigurationError if JWT is not configured

Since​

6.2.0

Example​

Update a comment

const result = await sdk.updateComment('msg-1234567890123-abc...', {
  content: 'Updated comment content'
});
console.log('Updated at:', result.comment.updatedAt);

Configuration​

getConfig()​

getConfig(): LaunchpadSDKConfigResponse

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:752

Gets the current SDK configuration

Returns a copy of the SDK configuration with sensitive data removed. The wallet instance is excluded for security reasons.

Includes the GalaChain gas fee (fixed at 1 GALA) which is applied to all blockchain transactions.

Returns​

LaunchpadSDKConfigResponse

SDK configuration object including:

  • environment: Current environment (stage or prod)
  • gasFee: GalaChain gas fee (fixed at "1" GALA)
  • slippageToleranceFactor: Effective slippage tolerance
  • calculateAmountMode: Calculation mode (local or external)
  • Base URLs and other configuration settings

Since​

1.0.0

Examples​

Inspect SDK configuration

const sdk = new LaunchpadSDK({
  wallet,
  baseUrl: 'https://api.example.com',
  timeout: 45000,
  debug: true
});

const config = sdk.getConfig();
console.log('Base URL:', config.baseUrl);
console.log('Timeout:', config.timeout);
console.log('Debug mode:', config.debug);
console.log('Gas Fee:', config.gasFee); // "1" GALA
// wallet property is not included for security

Configuration validation

const config = sdk.getConfig();
if (config.debug) {
  console.log('Debug mode is enabled - detailed logging active');
}
if (config.timeout < 30000) {
  console.warn('Timeout is quite low, consider increasing for stability');
}

getPlatformConfig()​

getPlatformConfig(): Promise<PlatformConfig>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5978

Get current platform configuration.

Public endpoint - no authentication required.

Returns global platform settings affecting all tokens and streams:

  • Whether streaming is enabled globally
  • Whether chat is enabled globally
  • Whether comments are enabled globally
  • Whether webhooks are enabled globally

Returns​

Promise<PlatformConfig>

Current platform configuration

Since​

7.3.0

Example​

Get platform configuration

const config = await sdk.getPlatformConfig();

if (!config.streamingEnabled) {
  console.log('Platform streaming is disabled');
}

if (!config.chatEnabled) {
  console.log('Platform chat is disabled');
}

getRestrictedNames()​

getRestrictedNames(): Promise<GetRestrictedNamesResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6035

Get the restricted token names content (Overseer only).

Returns a newline-separated list of restricted words that cannot be used in token names.

Requires JWT authentication with overseer role.

Returns​

Promise<GetRestrictedNamesResult>

Promise Success/error with content

Since​

7.0.0

Example​

const result = await sdk.getRestrictedNames();
if (result.success) {
  const words = result.data.content.split('\n').filter(w => w.trim());
  console.log('Restricted words:', words);
}

updatePlatformConfig()​

updatePlatformConfig(options): Promise<PlatformConfig>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6013

Update platform configuration.

Requires JWT authentication with admin or overseer role.

Performs a partial update - only provide fields to change. Other fields remain unchanged.

Parameters​

options​

UpdatePlatformConfigOptions

Configuration fields to update

Returns​

Promise<PlatformConfig>

Updated platform configuration

Throws​

ValidationError if options are invalid or missing

Throws​

ConfigurationError if JWT auth is not configured

Throws​

Error if user is not authorized (not admin or overseer)

Since​

7.3.0

Examples​

Disable streaming platform-wide

const updated = await sdk.updatePlatformConfig({
  streamingEnabled: false
});
console.log('Streaming disabled globally');

Disable multiple features

const updated = await sdk.updatePlatformConfig({
  streamingEnabled: false,
  chatEnabled: false,
  commentsEnabled: false
});

updateRestrictedNames()​

updateRestrictedNames(request): Promise<UpdateRestrictedNamesResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6061

Update the restricted token names content (Overseer only).

Replaces the entire list with newline-separated words. Contains offensive words - not exposed publicly.

Requires JWT authentication with overseer role.

Parameters​

request​

UpdateRestrictedNamesRequest

Request containing newline-separated content

Returns​

Promise<UpdateRestrictedNamesResult>

Promise Success or error

Throws​

If content is not provided

Since​

7.0.0

Example​

const result = await sdk.updateRestrictedNames({
  content: 'scam\nrug\nfake\nfraud\n...'
});
if (result.success) {
  console.log('Restricted names updated');
}

ContentReactions​

addContentReaction()​

addContentReaction(options): Promise<AddContentReactionResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5439

Add a reaction to a pool message (chat or comment).

Requires JWT or API key authentication. Adding the same reaction type again is a no-op (idempotent). Users can have multiple different reaction types on the same message.

Parameters​

options​

AddContentReactionOptions

Options including messageId and reactionType

Returns​

Promise<AddContentReactionResult>

Updated reaction data and whether reaction was newly created

Throws​

ValidationError if parameters are invalid

Throws​

ConfigurationError if authentication is not configured

Since​

5.12.0

Example​

Add a heart reaction

const result = await sdk.addContentReaction({
  messageId: 'msg-1703443200000-a1b2c3d4e5f6789012345678901234ab',
  reactionType: 'heart'
});
console.log('Created:', result.created);
console.log('Total reactions:', result.data.totalCount);

addReactionToChatMessage()​

addReactionToChatMessage(options): Promise<AddContentReactionResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5482

Add a reaction to a chat message.

Convenience wrapper for addContentReaction specifically for chat messages.

Parameters​

options​

AddContentReactionOptions

Options including messageId and reactionType

Returns​

Promise<AddContentReactionResult>

Updated reaction data

Since​

5.12.0

Example​

Add a fire reaction to a chat message

await sdk.addReactionToChatMessage({
  messageId: 'msg-1703443200000-a1b2c3d4e5f6789012345678901234ab',
  reactionType: 'fire'
});

addReactionToComment()​

addReactionToComment(options): Promise<AddContentReactionResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5522

Add a reaction to a comment.

Convenience wrapper for addContentReaction specifically for comments.

Parameters​

options​

AddContentReactionOptions

Options including messageId and reactionType

Returns​

Promise<AddContentReactionResult>

Updated reaction data

Since​

5.12.0

Example​

Add a thumbs_up reaction to a comment

await sdk.addReactionToComment({
  messageId: 'msg-1703443200000-a1b2c3d4e5f6789012345678901234ab',
  reactionType: 'thumbs_up'
});

removeContentReaction()​

removeContentReaction(options): Promise<RemoveContentReactionResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5462

Remove a reaction from a pool message.

Requires JWT or API key authentication. Only the user who created the reaction can remove it.

Parameters​

options​

RemoveContentReactionOptions

Options including messageId and reactionType

Returns​

Promise<RemoveContentReactionResult>

Success indicator

Throws​

ValidationError if parameters are invalid

Throws​

ConfigurationError if authentication is not configured

Since​

5.12.0

Example​

Remove a heart reaction

await sdk.removeContentReaction({
  messageId: 'msg-1703443200000-a1b2c3d4e5f6789012345678901234ab',
  reactionType: 'heart'
});

removeReactionFromChatMessage()​

removeReactionFromChatMessage(options): Promise<RemoveContentReactionResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5502

Remove a reaction from a chat message.

Convenience wrapper for removeContentReaction specifically for chat messages.

Parameters​

options​

RemoveContentReactionOptions

Options including messageId and reactionType

Returns​

Promise<RemoveContentReactionResult>

Success indicator

Since​

5.12.0

Example​

Remove a fire reaction from a chat message

await sdk.removeReactionFromChatMessage({
  messageId: 'msg-1703443200000-a1b2c3d4e5f6789012345678901234ab',
  reactionType: 'fire'
});

removeReactionFromComment()​

removeReactionFromComment(options): Promise<RemoveContentReactionResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5542

Remove a reaction from a comment.

Convenience wrapper for removeContentReaction specifically for comments.

Parameters​

options​

RemoveContentReactionOptions

Options including messageId and reactionType

Returns​

Promise<RemoveContentReactionResult>

Success indicator

Since​

5.12.0

Example​

Remove a thumbs_up reaction from a comment

await sdk.removeReactionFromComment({
  messageId: 'msg-1703443200000-a1b2c3d4e5f6789012345678901234ab',
  reactionType: 'thumbs_up'
});

Events​

getEventStats()​

getEventStats(): Promise<EventStats>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5300

Aggregate event statistics (GET /v1/events/stats). Admin API key or Overseer JWT.

Returns​

Promise<EventStats>

Event totals, today's count, unique users and tokens, and the count per event type

Throws​

ConfigurationError if neither an admin API key nor a JWT is configured

Since​

9.0.0

Example​

const stats = await sdk.getEventStats();
console.log(stats.totalEvents, stats.eventsByType);

queryEvents()​

queryEvents(options?): Promise<QueryEventsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5318

One page of stored events (GET /v1/events). Admin API key or Overseer JWT. Paging is offset style (page, limit 1..100), not a cursor.

Parameters​

options?​

QueryEventsOptions

Filters (user, token, event types, dates, search), paging and sorting

Returns​

Promise<QueryEventsResult>

{ data, pagination: { page, limit, total, totalPages } }

Throws​

ValidationError for an out-of-range limit / page or an unknown sort, preset or source

Throws​

ConfigurationError if neither an admin API key nor a JWT is configured

Since​

9.0.0

Example​

const page = await sdk.queryEvents({ tokenName: 'anime', eventTypes: ['token_buy'], page: 1, limit: 50 });
console.log(page.pagination.total, page.data[0]?.eventType);

External Calculations​

calculateBuyAmountExternal()​

calculateBuyAmountExternal(options): Promise<AmountCalculationResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7546

Calculate buy amount using external GalaChain call

Makes a network request to GalaChain to calculate buy amounts. Always returns fresh calculations based on current blockchain state. Use when you want guaranteed accuracy but don't mind network latency.

Parameters​

options​

Buy amount calculation options

amount​

string

tokenName​

string

type​

"native" | "exact"

Returns​

Promise<AmountCalculationResult>

Promise Calculated amount and fees from GalaChain

Deprecated​

Use getTradeQuote() instead — it uses the backend-proxy for instant calculations without a direct GalaChain call. The swap backend has removed direct chain quote endpoints in favour of the backend-proxy approach.

Throws​

NetworkError if API request fails

Since​

3.8.0

calculateSellAmountExternal()​

calculateSellAmountExternal(options): Promise<AmountCalculationResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7568

Calculate sell amount using external GalaChain call

Makes a network request to GalaChain to calculate sell amounts. Always returns fresh calculations based on current blockchain state. Use when you want guaranteed accuracy but don't mind network latency.

Parameters​

options​

Sell amount calculation options

amount​

string

tokenName​

string

type​

"native" | "exact"

Returns​

Promise<AmountCalculationResult>

Promise Calculated amount and fees from GalaChain

Deprecated​

Use getTradeQuote() instead — it uses the backend-proxy for instant calculations without a direct GalaChain call. The swap backend has removed direct chain quote endpoints in favour of the backend-proxy approach.

Throws​

NetworkError if API request fails

Since​

3.8.0

Flags​

actionFlag()​

actionFlag(options): Promise<ActionFlagResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4130

Take action on a flag.

Actions available:

  • DELETE_CONTENT: Remove the flagged content
  • BAN_USER: Ban the reported user from the token
  • DELETE_AND_BAN: Both delete content and ban user

Parameters​

options​

ActionFlagOptions

Action options

Returns​

Promise<ActionFlagResult>

Updated flag data with action taken

Throws​

Error if not authorized, flag not found, or action invalid

Since​

5.8.0

Examples​

Delete the flagged content

const result = await sdk.actionFlag({
  flagId: 123,
  action: FlagAction.DELETE_CONTENT,
});

Delete content and ban user

const result = await sdk.actionFlag({
  flagId: 123,
  action: FlagAction.DELETE_AND_BAN,
});

createFlag()​

createFlag(options): Promise<CreateFlagResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4032

Create a content flag/report.

Two-tier system:

  • Chat/Comment: reason and details are optional (one-click flag)
  • Stream: reason is required (modal flow)

Parameters​

options​

CreateFlagOptions

Flag creation options

Returns​

Promise<CreateFlagResult>

Created flag data

Throws​

Error if not authenticated or validation fails

Since​

5.8.0

Examples​

One-click flag on chat message

const result = await sdk.createFlag({
  tokenName: 'mytoken',
  contentType: ContentType.CHAT_MESSAGE,
  contentId: 'msg-123',
  reportedUserAddress: 'eth|abc...',
});

Stream report with required reason

const result = await sdk.createFlag({
  tokenName: 'mytoken',
  contentType: ContentType.STREAM,
  contentId: 'stream-456',
  reportedUserAddress: 'eth|abc...',
  reason: FlagReason.INAPPROPRIATE_CONTENT,
  details: 'Explicit content',
});

dismissFlag()​

dismissFlag(options): Promise<DismissFlagResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4098

Dismiss a flag (no action taken).

Marks the flag as reviewed but takes no action on the content.

Parameters​

options​

DismissFlagOptions

Dismiss options

Returns​

Promise<DismissFlagResult>

Updated flag data

Throws​

Error if not authorized or flag not found

Since​

5.8.0

Example​

Dismiss a flag

const result = await sdk.dismissFlag({ flagId: 123 });
console.log(result.flag.status); // 'DISMISSED'

listFlags()​

listFlags(options): Promise<FlagListResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4065

List flags for a token with pagination and filtering.

Authorization varies by content type:

  • CHAT_MESSAGE/COMMENT: Owner or Moderator (JWT) can view
  • STREAM: Admin API key only

Parameters​

options​

ListFlagsOptions

List options with filters

Returns​

Promise<FlagListResult>

Paginated list of flags

Throws​

Error if not authorized

Since​

5.8.0

Examples​

List pending flags

const result = await sdk.listFlags({
  tokenName: 'mytoken',
  status: FlagStatus.PENDING,
});
console.log(`Found ${result.flags.length} pending flags`);

List flags with pagination

const result = await sdk.listFlags({
  tokenName: 'mytoken',
  contentType: ContentType.CHAT_MESSAGE,
  pageSize: 50,
});

listGlobalFlags()​

listGlobalFlags(options?): Promise<FlagListResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4079

List flags globally across all tokens (Overseer only).

Returns paginated flags matching filter criteria across the platform. Requires OVERSEER role for access.

Parameters​

options?​

ListGlobalFlagsOptions

Filter and pagination options

Returns​

Promise<FlagListResult>

Paginated list of flags

Throws​

Error if not authorized as overseer

Since​

6.2.0

Health​

getHealth()​

getHealth(): Promise<HealthCheckResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5285

The launchpad backend's dependency health (GET /health). Public: no Authorization header.

A critical dependency being down answers HTTP 503, which throws a NetworkError.

Returns​

Promise<HealthCheckResponse>

Overall status and the state of each dependency

Since​

9.0.0

Example​

const health = await sdk.getHealth();
console.log(health.status, health.database?.status, health.redis?.status);

Local Calculations​

calculateBuyAmountLocal()​

calculateBuyAmountLocal(options): Promise<AmountCalculationResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7486

Calculate buy amount locally using bonding curve formula

Performs instant client-side calculation without network calls to GalaChain. Uses exponential bonding curve mathematics to calculate GALA costs or token amounts. Requires the current token supply to perform accurate calculations.

This method enables instant price quotes and real-time calculations without API rate limits or network latency. Perfect for building responsive UIs that show live pricing as users adjust their trade amounts.

Parameters​

options​

CalculateBuyAmountLocalOptions

Local calculation options with currentSupply

Returns​

Promise<AmountCalculationResult>

Promise Calculated amount and fees

Throws​

ValidationError if parameters are invalid

Since​

3.8.0

Examples​

Calculate GALA needed to buy 1000 tokens

const result = await sdk.calculateBuyAmountLocal({
  tokenName: 'mytoken',
  amount: '1000',
  type: 'exact',
  currentSupply: '500000'
});
console.log('GALA needed:', result.amount);
console.log('Transaction fee:', result.transactionFee);

Calculate tokens received for 100 GALA

const result = await sdk.calculateBuyAmountLocal({
  tokenName: 'mytoken',
  amount: '100',
  type: 'native',
  currentSupply: '500000'
});
console.log('Tokens received:', result.amount);

calculateSellAmountLocal()​

calculateSellAmountLocal(options): Promise<AmountCalculationResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7528

Calculate sell amount locally using bonding curve formula

Performs instant client-side calculation without network calls to GalaChain. Uses exponential bonding curve mathematics to calculate GALA received or tokens needed. Requires the current token supply to perform accurate calculations.

This method enables instant price quotes and real-time calculations without API rate limits or network latency. Includes reverse bonding curve fee calculation that scales with supply.

Parameters​

options​

CalculateSellAmountLocalOptions

Local calculation options with currentSupply

Returns​

Promise<AmountCalculationResult>

Promise Calculated amount and fees

Throws​

ValidationError if parameters are invalid

Since​

3.8.0

Examples​

Calculate GALA received when selling 500 tokens

const result = await sdk.calculateSellAmountLocal({
  tokenName: 'mytoken',
  amount: '500',
  type: 'exact',
  currentSupply: '500000'
});
console.log('GALA received:', result.amount);
console.log('Reverse bonding fee:', result.reverseBondingCurveFee);
console.log('Transaction fee:', result.transactionFee);

Calculate tokens needed to receive 50 GALA

const result = await sdk.calculateSellAmountLocal({
  tokenName: 'mytoken',
  amount: '50',
  type: 'native',
  currentSupply: '500000'
});
console.log('Tokens to sell:', result.amount);

Main SDK​

fetchAllReferrals()​

fetchAllReferrals(options?): Promise<AllReferralsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8295

Fetch all referrals for a wallet address (auto-paginated)

Automatically fetches all pages and returns the complete list of referrals. Use this when you need all referral data without manual pagination.

Wallet requirement: If no address is provided, uses the SDK wallet address. You can optionally pass any wallet address to fetch their referrals.

Parameters​

options?​

Omit<FetchReferralsOptions, "page" | "limit">

Optional fetch parameters

Returns​

Promise<AllReferralsResult>

Promise All referral data

Throws​

If wallet not configured and no address provided

Throws​

If DEX API request fails

Since​

4.0.23

Examples​

Fetch all referrals

const result = await sdk.fetchAllReferrals();
console.log(`Total referrals: ${result.total}`);

// Calculate total rewards
const totalRewards = result.referrals.reduce((sum, ref) => {
  const galaRewards = ref.rewards.filter(r => r.tokenClassKey.collection === 'GALA');
  return sum + galaRewards.reduce((s, r) => s + r.quantity, 0);
}, 0);
console.log(`Total GALA earned from referrals: ${totalRewards}`);

Fetch all referrals for a specific address

const result = await sdk.fetchAllReferrals({
  address: 'client|689e38a801386ddc6fca8c9f'
});

fetchGalaBalance()​

fetchGalaBalance(address?): Promise<TokenBalanceResult | null>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1476

Fetch GALA token balance for a wallet address

Retrieves the current GALA token balance for a specified wallet address or the authenticated user's wallet if no address is provided. Returns complete balance information including token quantity, token metadata, and collection details from GalaChain.

Supports both address formats:

  • Standard Ethereum format: 0x... (64 hex characters after 0x prefix)
  • Backend format: eth|... (full GalaChain address format)

Parameters​

address?​

string

Optional wallet address in 0x... or eth|... format. Defaults to current SDK wallet address.

Returns​

Promise<TokenBalanceResult | null>

Promise Complete balance details including quantity and token metadata

Throws​

If wallet is not configured and no address is provided

Throws​

If GalaChain query fails or network connection is unavailable

Since​

4.0.4-beta.0

Examples​

Fetch balance for authenticated wallet

const balance = await sdk.fetchGalaBalance();
console.log(`Your GALA balance: ${balance.quantity}`);

Fetch balance for specific address

const address = 'eth|742d35Cc6634C0532925a3b8D0Ea2c76f94C31C0';
const balance = await sdk.fetchGalaBalance(address);
console.log(`Balance: ${balance.quantity} GALA`);

Fetch and format balance

const balance = await sdk.fetchGalaBalance();
const formattedBalance = (BigInt(balance.quantity) / BigInt(10 ** 8)).toString();
console.log(`GALA: ${formattedBalance}`);

fetchLaunchpadFee()​

fetchLaunchpadFee(): Promise<number>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6248

Fetch the current launchpad fee via backend proxy (cached 1 hour).

Same value as fetchLaunchTokenFee() (which delegates here) — no chain call.

Returns​

Promise<number>

Promise resolving to the fee amount in GALA (number)

Since​

9.1.0

Example​

const fee = await sdk.fetchLaunchpadFee();
console.log(`Current launchpad fee: ${fee} GALA`);

fetchProfile()​

fetchProfile(address?): Promise<PublicUserProfile>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8176

Fetch user profile information by wallet address

GET /v1/users/:address (public, no authentication): name, profile image, bio, aggregated stats and the four badge ladders. An address with no profile row still answers a profile (fullName, profileImage and bio are null).

Supports both address formats:

  • Standard Ethereum format: 0x... (64 hex characters after 0x prefix)
  • Backend format: eth|... (full GalaChain address format)

Parameters​

address?​

string

Optional wallet address in 0x... or eth|... format. Defaults to current SDK wallet address.

Returns​

Promise<PublicUserProfile>

The public profile (the data of the backend's envelope)

Throws​

If wallet is not configured and no address is provided

Throws​

If launchpad API request fails, or answers a body that is not a profile

Since​

4.0.4-beta.0

Since​

9.0.0 - typed PublicUserProfile (it returned the whole { data } envelope as unknown)

Examples​

Fetch current user's profile

const profile = await sdk.fetchProfile();
console.log(`User: ${profile.fullName}, tokens created: ${profile.stats.tokensCreated}`);

Fetch profile for specific address

const profile = await sdk.fetchProfile('eth|742d35Cc6634C0532925a3b8D0Ea2c76f94C31C0');
console.log(`Profile owner: ${profile.fullName}`);

fetchReferrals()​

fetchReferrals(options?): Promise<ReferralsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8255

Fetch referrals for a wallet address with pagination

Returns a paginated list of users who signed up using this wallet's referral link, including relationship level, join date, and rewards earned from each referral.

Wallet requirement: If no address is provided, uses the SDK wallet address. You can optionally pass any wallet address to fetch their referrals.

Parameters​

options?​

FetchReferralsOptions

Optional fetch parameters

Returns​

Promise<ReferralsResult>

Promise Paginated referral data

Throws​

If wallet not configured and no address provided

Throws​

If DEX API request fails

Since​

4.0.23

Examples​

Fetch first page of referrals

const result = await sdk.fetchReferrals();
console.log(`Found ${result.referrals.length} referrals`);
result.referrals.forEach(ref => {
  console.log(`${ref.walletAddress} joined ${ref.joined}, level ${ref.relationshipLevel}`);
});

Fetch with pagination

const page2 = await sdk.fetchReferrals({ pageSize: 20 });
if (page2.hasMore) {
  console.log('More pages available');
}

Fetch referrals for a specific address

const referrals = await sdk.fetchReferrals({
  address: 'eth|1234567890abcdef...',
  sortDir: 'asc'
});

fetchReferralsSummary()​

fetchReferralsSummary(options?): Promise<ReferralsSummaryResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8330

Fetch referral summary statistics for a wallet address

Returns aggregate counts and reward totals for the referral program without listing individual referrals. Perfect for dashboard displays and quick overviews.

Wallet requirement: If no address is provided, uses the SDK wallet address. You can optionally pass any wallet address to fetch their summary.

Parameters​

options?​

FetchReferralsSummaryOptions

Optional fetch parameters

Returns​

Promise<ReferralsSummaryResult>

Promise Referral counts and reward totals

Throws​

If wallet not configured and no address provided

Throws​

If address format is invalid

Throws​

If DEX API request fails or returns unexpected format

Since​

4.0.23

Examples​

Fetch referral summary for current wallet

const summary = await sdk.fetchReferralsSummary();
console.log(`Total referrals: ${summary.referralCount}`);
console.log(`Total rewards: ${summary.rewardTotals.total} GALA`);
console.log(`Past month: ${summary.rewardTotals.pastMonth} GALA`);
console.log(`Past day: ${summary.rewardTotals.pastDay} GALA`);

Fetch summary for a specific address

const summary = await sdk.fetchReferralsSummary({
  address: 'eth|1234567890abcdef...'
});

fetchReferralUrl()​

fetchReferralUrl(): Promise<ReferralUrlResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8209

Fetch the current user's referral URL

Retrieves the unique referral URL for the authenticated wallet from the DEX API platform. The referral URL can be shared to earn referral rewards when new users sign up through the link.

Requires wallet configuration - the wallet address is used to identify the user and fetch their unique referral code.

Returns​

Promise<ReferralUrlResult>

Promise The referral URL result containing the URL string

Throws​

If wallet is not configured

Throws​

If DEX API request fails

Since​

4.0.18

Examples​

Fetch and share referral URL

const result = await sdk.fetchReferralUrl();
console.log('Share this link:', result.url);
// Example: https://connect.gala.com/?r=69026333c58ce14673aa97e0

Use in a referral program UI

const { url } = await sdk.fetchReferralUrl();

// Copy to clipboard
await navigator.clipboard.writeText(url);
console.log('Referral URL copied!');

fetchSaleDetails()​

fetchSaleDetails(tokenName): Promise<SaleDetailsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6267

Fetch sale details (supply, status) for a token via backend proxy (cached 10 seconds).

Uses tokenName; the backend resolves the vaultAddress internally.

Parameters​

tokenName​

string

Token name (e.g. 'anime')

Returns​

Promise<SaleDetailsResult>

Promise resolving to sale details including supply, quantities, and status

Since​

9.1.0

Example​

const details = await sdk.fetchSaleDetails('anime');
console.log(`Supply: ${details.sellingTokenQuantity} / ${details.maxSupply}`);
console.log(`Status: ${details.saleStatus}`);

getPremintQuote()​

getPremintQuote(amount): Promise<AmountCalculationResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6316

Calculate a pre-mint token output for a given GALA amount (supply = 0 assumed).

Used during the token creation flow. The backend assumes supply = 0 and computes via local bonding curve math — no chain call required.

Parameters​

amount​

string

GALA amount to spend (as a decimal string, e.g. '100')

Returns​

Promise<AmountCalculationResult>

Promise resolving to amount calculation result with fees

Since​

9.1.0

Example​

const quote = await sdk.getPremintQuote('500');
console.log(`Initial purchase will yield: ${quote.amount} tokens`);
console.log(`Transaction fee: ${quote.transactionFee} GALA`);

getTradeQuote()​

getTradeQuote(params): Promise<AmountCalculationResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6296

Calculate a trade quote via the backend using local bonding curve math (no chain call).

Instant alternative to calculateBuyAmountExternal() / calculateSellAmountExternal(). The backend uses its local bonding curve math — no GalaChain network request.

Parameters​

params​

TradeQuoteParams

Quote parameters

Returns​

Promise<AmountCalculationResult>

Promise resolving to amount calculation result with fees

Since​

9.1.0

Example​

Buy: how many tokens for 100 GALA?

const quote = await sdk.getTradeQuote({
  tokenName: 'anime',
  amount: '100',
  type: 'NATIVE',
  method: 'IN',
});
console.log(`You will receive: ${quote.amount} tokens`);
console.log(`Fee: ${quote.reverseBondingCurveFee} GALA`);

updateProfile()​

updateProfile(data): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8379

Update user profile information for a wallet address

Updates public profile metadata for a wallet, including display name and profile image. Only the wallet owner can update their own profile. Changes take effect immediately after successful submission to the launchpad server.

Requires a JWT (the backend updates the user of the token). Only the fields given are sent: an omitted field is left as it is, profileImage: '' clears the image.

Parameters​

data​

UpdateProfileData

Profile update data (at least one of fullName and profileImage)

Returns​

Promise<void>

Promise No return data - throws on failure

Throws​

If the address or name is invalid or nothing is given

Throws​

If launchpad API request fails

Since​

4.0.4-beta.0

Examples​

Update profile name and image

await sdk.updateProfile({
  address: sdk.getAddress(),
  fullName: 'John Crypto',
  profileImage: 'https://example.com/profile-pic.png'
});

console.log('Profile updated successfully!');

Update only name

await sdk.updateProfile({
  address: sdk.getAddress(),
  fullName: 'Jane Blockchain'
});

Clear profile image

await sdk.updateProfile({
  address: sdk.getAddress(),
  profileImage: '' // Clear image
});

uploadProfileImage()​

uploadProfileImage(options): Promise<string>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8406

Upload a profile image for the logged-in user (POST /v1/users/me/image)

Takes the image as a browser File or a Node.js Buffer and answers the URL it is served from. The backend uploads for the user of the session JWT, so the route needs no address and no wallet: it works on an SDK configured with a signer and a wallet address (and a session, or after login()). An address that is given is validated and only names the multipart file.

Parameters​

options​

UploadProfileImageOptions

Profile image upload options

Returns​

Promise<string>

Promise URL where the profile image is hosted and can be accessed

Throws​

If the address is not a valid address

Throws​

If there is no session or logged-in token

Throws​

If upload request fails (the backend's answer is kept: its size limit, 400 for a bad format)

Since​

4.0.4-beta.0

Since​

9.0.0 - needs no wallet and no address (it threw "Wallet is required" on a signer-plus-address SDK)

Example​

Upload a profile image

const imageUrl = await sdk.uploadProfileImage({ file: imageBuffer });
console.log(`Profile image uploaded: ${imageUrl}`);

uploadTokenImage()​

uploadTokenImage(options): Promise<string>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8005

Upload a token image (POST /v1/tokens/:tokenName/image)

Takes the image as a browser File or a Node.js Buffer and answers the URL it is served from. The route needs only the logged-in session's bearer: it works on an SDK configured with a signer and a wallet address (and a session, or after login()), with no wallet. The token must be the caller's to manage; the backend answers 403 otherwise.

Parameters​

options​

UploadImageByTokenNameOptions

{ tokenName, options: { file } }

Returns​

Promise<string>

Promise URL where the image is hosted and can be accessed

Throws​

If tokenName is invalid or the file is not an image

Throws​

If there is no session or logged-in token

Throws​

If upload request fails (the backend's answer is kept: its size limit, 403, 404)

Since​

4.0.4-beta.0

Since​

9.0.0 - needs no wallet (it threw "Wallet is required" on a signer-plus-address SDK)

Example​

Upload an image

const imageUrl = await sdk.uploadTokenImage({
  tokenName: 'mytoken',
  options: { file: imageBuffer }
});
console.log(`Image uploaded: ${imageUrl}`);

Messages​

createMessage()​

createMessage<T>(options): Promise<CreateMessageResult<T>>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5812

Create a new message (chat or comment).

Requires JWT authentication.

Type Parameters​

T​

T extends MessageType

Parameters​

options​

CreateMessageOptions<T>

Create options including type, tokenName, and content

Returns​

Promise<CreateMessageResult<T>>

The created message

Throws​

ValidationError if options are invalid

Throws​

ConfigurationError if JWT is not configured

Since​

7.0.0

Examples​

Create a chat message

const result = await sdk.createMessage({
  type: 'CHAT_MESSAGE',
  tokenName: 'anime',
  content: 'Hello world!'
});
console.log('Created message ID:', result.message.messageId);

Create a comment

const result = await sdk.createMessage({
  type: 'COMMENT',
  tokenName: 'anime',
  content: 'Great project!'
});

deleteMessage()​

deleteMessage(id): Promise<DeleteMessageResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5857

Delete a message.

Requires authentication (JWT or API key). Authorization: message author, token owner, moderator, or admin.

Parameters​

id​

string

Message ID to delete

Returns​

Promise<DeleteMessageResult>

Success indicator

Throws​

ValidationError if ID is invalid

Throws​

ConfigurationError if neither JWT nor API key is configured

Since​

7.0.0

Example​

Delete a message

await sdk.deleteMessage('msg-1234567890123-abc...');
console.log('Message deleted');

fetchMessages()​

fetchMessages(options): Promise<FetchMessagesResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5779

Fetch messages with optional filtering by type, token, or user.

Unified endpoint for all message types (CHAT and COMMENT). Public endpoint - no authentication required. At least one of type, tokenName, or userAddress must be provided.

Parameters​

options​

FetchMessagesOptions

Query options including type/tokenName/userAddress and pagination

Returns​

Promise<FetchMessagesResult>

Paginated list of messages

Throws​

ValidationError if no filter is provided or options are invalid

Since​

7.0.0

Examples​

Get chat messages for a token

const { messages, pageInfo } = await sdk.fetchMessages({
  type: 'CHAT_MESSAGE',
  tokenName: 'anime'
});
console.log(`Found ${pageInfo.totalCount} chat messages`);

Get comments for a token

const { messages, pageInfo } = await sdk.fetchMessages({
  type: 'COMMENT',
  tokenName: 'anime'
});

Get all messages from a user with pagination

const result = await sdk.fetchMessages({
  userAddress: 'eth|123...',
  pageSize: 20,
  cursor: 'next_cursor'
});

getMessageStats()​

getMessageStats(): Promise<MessageStats>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5948

Get platform-wide message statistics.

Requires admin API key or overseer JWT (AdminOrOverseerGuard).

Returns aggregated message metrics including:

  • Total message count
  • Today's message count
  • Unique users and tokens
  • Message counts by type (CHAT_MESSAGE, COMMENT)

Returns​

Promise<MessageStats>

Platform-wide message statistics

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

9.1.0

Example​

Get message statistics

const stats = await sdk.getMessageStats();
console.log('Total messages:', stats.totalMessages);
console.log('Today:', stats.todayMessages);
console.log('Unique users:', stats.uniqueUsers);
console.log('Unique tokens:', stats.uniqueTokens);
console.log('By type:', stats.messagesByType);

getPinnedMessage()​

getPinnedMessage(tokenName): Promise<PinnedMessageResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5879

Get the currently pinned message for a token.

Public endpoint - no authentication required.

Parameters​

tokenName​

string

Token name to get pinned message for

Returns​

Promise<PinnedMessageResult>

The pinned message or null if none

Since​

7.0.0

Example​

Get pinned message

const result = await sdk.getPinnedMessage('anime');
if (result.message) {
  console.log('Pinned:', result.message.content);
} else {
  console.log('No message pinned');
}

pinMessage()​

pinMessage(id): Promise<PinMessageResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5900

Pin a message.

Requires JWT authentication with owner or moderator role. Only one message can be pinned per token at a time.

Parameters​

id​

string

Message ID to pin

Returns​

Promise<PinMessageResult>

Success indicator

Throws​

ValidationError if ID is invalid

Throws​

ConfigurationError if JWT is not configured

Since​

7.0.0

Example​

Pin a message

await sdk.pinMessage('msg-1234567890123-abc...');
console.log('Message pinned');

unpinMessage()​

unpinMessage(id): Promise<PinMessageResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5920

Unpin a message.

Requires JWT authentication with owner or moderator role.

Parameters​

id​

string

Message ID to unpin

Returns​

Promise<PinMessageResult>

Success indicator

Throws​

ValidationError if ID is invalid

Throws​

ConfigurationError if JWT is not configured

Since​

7.0.0

Example​

Unpin a message

await sdk.unpinMessage('msg-1234567890123-abc...');
console.log('Message unpinned');

updateMessage()​

updateMessage<T>(id, options): Promise<UpdateMessageResult<T>>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5836

Update a message's content.

Requires JWT authentication. Only the message author can update.

Type Parameters​

T​

T extends MessageType = MessageType

Parameters​

id​

string

Message ID to update

options​

UpdateMessageOptions<T>

Update options including new content

Returns​

Promise<UpdateMessageResult<T>>

The updated message

Throws​

ValidationError if ID or content is invalid

Throws​

ConfigurationError if JWT is not configured

Since​

7.0.0

Example​

Update a message

const result = await sdk.updateMessage('msg-1234567890123-abc...', {
  content: 'Updated message content',
  type: 'COMMENT'
});
console.log('Updated at:', result.message.updatedAt);

Moderation​

createBan()​

createBan(options): Promise<CreateBanResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3354

Create a ban for a user on a token.

Bans a user from participating in chat, comments, and reactions for the specified token. Can be temporary (with duration) or permanent.

Supports dual authentication:

  • Admin (API key): Can ban any user on any token
  • Owner (JWT): Can ban users on their own token

Parameters​

options​

CreateBanOptions

Ban creation options

Returns​

Promise<CreateBanResult>

Promise resolving to the created ban

Throws​

Error if neither admin API key nor JWT is configured

Since​

5.5.0

Examples​

Ban a user permanently

const result = await sdk.createBan({
  tokenName: 'mytoken',
  userAddress: 'eth|abc123...',
  reason: 'Spam',
});
console.log(`Banned: ${result.ban.userAddress}`);

Ban a user for 24 hours

const result = await sdk.createBan({
  tokenName: 'mytoken',
  userAddress: 'eth|abc123...',
  reason: 'Warning for inappropriate content',
  durationSeconds: 86400, // 24 hours
});
console.log(`Expires: ${result.ban.expiresAt}`);

createGlobalBan()​

createGlobalBan(options): Promise<CreateGlobalBanResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3524

Create a global user ban (bans user from all tokens on the platform).

Global bans prevent a user from accessing any token, participating in streams, chat, or comments across the entire platform.

Requires admin API key or Overseer JWT authentication.

Parameters​

options​

CreateGlobalBanOptions

Global ban creation options

Returns​

Promise<CreateGlobalBanResult>

Promise resolving to created ban data

Throws​

ValidationError if options are invalid

Throws​

ConfigurationError if admin API key or JWT is not configured

Since​

6.x.0

Examples​

Permanent global ban

const result = await sdk.createGlobalBan({
  userAddress: 'eth|123...',
  reason: 'Serious platform violation'
});
console.log('User globally banned:', result.ban.userAddress);

Temporary global ban (7 days)

const result = await sdk.createGlobalBan({
  userAddress: 'eth|123...',
  reason: 'Spam across multiple streams',
  durationSeconds: 604800 // 7 days
});
console.log('Ban expires:', result.ban.expiresAt);

getActiveModerators()​

getActiveModerators(tokenName): Promise<object[]>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3909

Get the roster of active (already-accepted) moderators for a token.

There is no dedicated "active moderators" endpoint - a moderator's invite record IS their moderator record. This lists invites for the token with status 'CLAIMED', which is exactly the set of currently-active moderators (a PENDING invite has not been accepted yet; REVOKED/EXPIRED are no longer active).

Parameters​

tokenName​

string

Token to fetch the moderator roster for

Returns​

Promise<object[]>

Active moderators, with the invite's role, claimedBy address, and claimedAt date

Since​

7.1.0

getActiveUsers()​

getActiveUsers(options): Promise<ActiveUsersResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3488

Get active users for a token.

Returns a list of users currently viewing or participating in a stream. Can filter by viewer type (all viewers or only chat participants).

Returns up to 1000 users. If more are connected, the truncated flag will be true.

Supports dual authentication:

  • Admin (API key): Can get users for any token
  • Owner (JWT): Can get users for their own token

Parameters​

options​

GetActiveUsersOptions

Active users options

Returns​

Promise<ActiveUsersResult>

Promise resolving to active users list

Throws​

Error if neither admin API key nor JWT is configured

Since​

5.5.0

Examples​

Get all viewers

const result = await sdk.getActiveUsers({
  tokenName: 'mytoken',
  type: 'viewers',
});
console.log(`${result.total} viewers online`);
if (result.truncated) {
  console.log('More than 1000 users, list truncated');
}

Search for a specific user

const result = await sdk.getActiveUsers({
  tokenName: 'mytoken',
  type: 'chat_participants',
  search: 'alice', // Filter by address or name
});

getBanStatus()​

getBanStatus(options): Promise<BanStatusResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3446

Get ban status for a specific user on a token.

Checks if a user is currently banned and returns ban details if so.

Supports dual authentication:

  • Admin (API key): Can check any user on any token
  • Owner (JWT): Can check users on their own token

Parameters​

options​

GetBanStatusOptions

Status check options

Returns​

Promise<BanStatusResult>

Promise resolving to ban status

Throws​

Error if neither admin API key nor JWT is configured

Since​

5.5.0

Example​

Check if user is banned

const status = await sdk.getBanStatus({
  tokenName: 'mytoken',
  userAddress: 'eth|abc123...',
});
if (status.banned) {
  console.log(`Banned for: ${status.ban?.reason}`);
  console.log(`Expires: ${status.ban?.expiresAt ?? 'permanent'}`);
}

getGlobalBan()​

getGlobalBan(options): Promise<GlobalBanStatusResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3609

Get global ban status for a specific user.

Requires admin API key or Overseer JWT authentication.

Parameters​

options​

GetGlobalBanOptions

Global ban status options

Returns​

Promise<GlobalBanStatusResult>

Promise resolving to ban status (banned or not) with ban data if applicable

Throws​

ValidationError if options are invalid

Throws​

ConfigurationError if admin API key or JWT is not configured

Since​

6.x.0

Example​

const status = await sdk.getGlobalBan({
  userAddress: 'eth|123...'
});
if (status.banned) {
  console.log('User is globally banned');
  console.log('Reason:', status.ban?.reason);
  console.log('Expires:', status.ban?.expiresAt ?? 'permanent');
}

listBans()​

listBans(options): Promise<BanListResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3417

List all bans for a token.

Returns a paginated list of banned users with their profile information, ban reasons, and expiration times.

Supports dual authentication:

  • Admin (API key): Can list bans for any token
  • Owner (JWT): Can list bans for their own token

Parameters​

options​

ListBansOptions

List options including pagination and filters

Returns​

Promise<BanListResult>

Promise resolving to paginated ban list

Throws​

Error if neither admin API key nor JWT is configured

Since​

5.5.0

Examples​

List all bans

const result = await sdk.listBans({ tokenName: 'mytoken' });
console.log(`Total bans: ${result.pageInfo.totalCount}`);
result.bans.forEach(ban => {
  console.log(`${ban.userAddress}: ${ban.reason}`);
});

Search bans by user

const result = await sdk.listBans({
  tokenName: 'mytoken',
  search: 'alice', // Search by address or name
  pageSize: 20,
});

listGlobalBans()​

listGlobalBans(options?): Promise<GlobalBanListResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3583

List all global user bans on the platform.

Returns paginated results with user profile information. Supports filtering by user address or name.

Requires admin API key or Overseer JWT authentication.

Parameters​

options?​

ListGlobalBansOptions

List options with optional pagination and filters

Returns​

Promise<GlobalBanListResult>

Promise resolving to paginated list of global bans

Throws​

ValidationError if options are invalid

Throws​

ConfigurationError if admin API key or JWT is not configured

Since​

6.x.0

Examples​

Get first page of global bans

const result = await sdk.listGlobalBans({
  pageSize: 20
});
console.log('Total global bans:', result.pageInfo.totalCount);
result.items.forEach(ban => {
  console.log(`${ban.userAddress}: ${ban.reason}`);
});

Search for banned user

const result = await sdk.listGlobalBans({
  userAddress: 'eth|123...',
  pageSize: 10
});

removeBan()​

removeBan(options): Promise<RemoveBanResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3381

Remove a ban for a user on a token.

Unbans a user, allowing them to participate in chat, comments, and reactions again.

Supports dual authentication:

  • Admin (API key): Can unban any user on any token
  • Owner (JWT): Can unban users on their own token

Parameters​

options​

RemoveBanOptions

Ban removal options

Returns​

Promise<RemoveBanResult>

Promise resolving to removal confirmation

Throws​

Error if neither admin API key nor JWT is configured

Throws​

Error (404) if ban not found

Since​

5.5.0

Example​

Unban a user

const result = await sdk.removeBan({
  tokenName: 'mytoken',
  userAddress: 'eth|abc123...',
});
console.log(`Unbanned: ${result.removed}`);

removeGlobalBan()​

removeGlobalBan(options): Promise<RemoveGlobalBanResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3547

Remove a global user ban.

Requires admin API key or Overseer JWT authentication.

Parameters​

options​

RemoveGlobalBanOptions

Global ban removal options

Returns​

Promise<RemoveGlobalBanResult>

Promise resolving to removal confirmation

Throws​

ValidationError if options are invalid

Throws​

ConfigurationError if admin API key or JWT is not configured

Throws​

Error if ban not found

Since​

6.x.0

Example​

const result = await sdk.removeGlobalBan({
  userAddress: 'eth|123...'
});
console.log('Global ban removed:', result.removed);

NFT Collections​

claimNftCollection()​

claimNftCollection(params): Promise<ClaimCollectionResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9199

Claim an NFT collection name

Parameters​

params​

ClaimCollectionParams

Collection claim parameters

Returns​

Promise<ClaimCollectionResult>

Claim result with transaction ID

createNftTokenClass()​

createNftTokenClass(params): Promise<CreateTokenClassResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9220

Create a token class within an NFT collection

Parameters​

params​

CreateTokenClassParams

Token class creation parameters

Returns​

Promise<CreateTokenClassResult>

Creation result with transaction ID

estimateNftMintFee()​

estimateNftMintFee(params): Promise<string>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9185

Estimate minting fee for NFTs via DryRun

Parameters​

params​

EstimateMintFeeParams

Mint parameters (collection, type, category, quantity, owner)

Returns​

Promise<string>

Estimated fee in GALA

estimateNftOperationFees()​

estimateNftOperationFees(params): NftFeeEstimate

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9192

Calculate total fees for multiple NFT operations

Parameters​

params​

EstimateNftFeesParams

Operations to estimate (claimCollection, createTokenClasses count)

Returns​

NftFeeEstimate

Fee breakdown with total

fetchNftBalances()​

fetchNftBalances(ownerAddress, collectionFilter?): Promise<NftBalance[]>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9242

Fetch NFT balances for an owner

Parameters​

ownerAddress​

string

Owner wallet address

collectionFilter?​

string

Optional collection name to filter by

Returns​

Promise<NftBalance[]>

List of NFT balances

fetchNftCollections()​

fetchNftCollections(walletAddress): Promise<NftCollectionAuthorization[]>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9206

Fetch all NFT collections authorized to a user

Parameters​

walletAddress​

string

Wallet address to fetch collections for

Returns​

Promise<NftCollectionAuthorization[]>

List of authorized collections

fetchNftTokenClasses()​

fetchNftTokenClasses(params): Promise<NftTokenClassWithSupply[]>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9227

Fetch token classes for a collection

Parameters​

params​

FetchTokenClassesParams

Query parameters (collection, type, category)

Returns​

Promise<NftTokenClassWithSupply[]>

List of token classes with supply info

getNftCollectionClaimFee()​

getNftCollectionClaimFee(): string

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9172

Get the fee to claim an NFT collection

Returns​

string

Fee amount in GALA as string ("10000")

getNftTokenClassCreateFee()​

getNftTokenClassCreateFee(): string

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9178

Get the fee to create a token class

Returns​

string

Fee amount in GALA as string ("1000")

isNftCollectionAvailable()​

isNftCollectionAvailable(collectionName): Promise<boolean>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9213

Check if an NFT collection name is available

Parameters​

collectionName​

string

Collection name to check

Returns​

Promise<boolean>

True if available, false if already claimed

mintNft()​

mintNft(params): Promise<MintNftResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9234

Mint NFTs from a token class

Parameters​

params​

MintNftParams

Minting parameters

Returns​

Promise<MintNftResult>

Minting result with transaction ID

OEmbed​

getHomeOEmbed()​

getHomeOEmbed(options?): Promise<GetHomeOEmbedJsonResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5190

Get oEmbed metadata for the home page.

Returns oEmbed JSON data featuring the top/live token for social media previews.

Public endpoint - no authentication required.

Parameters​

options?​

GetHomeOEmbedOptions

Optional parameters

Returns​

Promise<GetHomeOEmbedJsonResult>

oEmbed data with featured token info

Since​

9.0.0

Example​

Get home page oEmbed

const { oembed } = await sdk.getHomeOEmbed();
console.log('Site:', oembed.provider_name);
console.log('Featured:', oembed.featuredToken);

getPoolOEmbed()​

getPoolOEmbed(options): Promise<GetPoolOEmbedJsonResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5214

Get oEmbed metadata for a pool/token page.

Returns oEmbed JSON data for a token's buy/sell page, including live stream status if applicable.

Public endpoint - no authentication required.

Parameters​

options​

GetPoolOEmbedOptions

Options with tokenName

Returns​

Promise<GetPoolOEmbedJsonResult>

oEmbed data with token info and live status

Throws​

ValidationError if tokenName is missing or invalid

Since​

9.0.0

Example​

Get pool oEmbed

const { oembed } = await sdk.getPoolOEmbed({ tokenName: 'anime' });
console.log('Token:', oembed.tokenName);
console.log('Symbol:', oembed.symbol);
console.log('Live:', oembed.isLive);

getProfileOEmbed()​

getProfileOEmbed(options): Promise<GetProfileOEmbedJsonResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5237

Get oEmbed metadata for a user profile page.

Returns oEmbed JSON data for a user's profile including stats.

Public endpoint - no authentication required.

Parameters​

options​

GetProfileOEmbedOptions

Options with address

Returns​

Promise<GetProfileOEmbedJsonResult>

oEmbed data with user stats

Throws​

ValidationError if address is missing or invalid

Since​

9.0.0

Example​

Get profile oEmbed

const { oembed } = await sdk.getProfileOEmbed({ address: 'eth|123...' });
console.log('User:', oembed.displayName);
console.log('Tokens created:', oembed.tokensCreated);
console.log('Volume:', oembed.totalVolumeGala);

Other​

launchpad​

readonly launchpad: LaunchpadWrites

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:431

v6 launchpad write surface.

DEFAULT_CALCULATE_AMOUNT_MODE​

readonly static DEFAULT_CALCULATE_AMOUNT_MODE: "local" | "external"

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:358

Default calculation mode for all amount calculations - 'local' for instant client-side bonding curve calculations

DEFAULT_LAUNCHPAD_TOKEN_MAX_SUPPLY​

readonly static DEFAULT_LAUNCHPAD_TOKEN_MAX_SUPPLY: 10000000

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:356

Default maximum total supply for launchpad tokens (10,000,000) - Used when token-specific maxSupply not provided

DEFAULT_MAX_ACCEPTABLE_REVERSE_BONDING_CURVE_FEE_SLIPPAGE_FACTOR​

readonly static DEFAULT_MAX_ACCEPTABLE_REVERSE_BONDING_CURVE_FEE_SLIPPAGE_FACTOR: 0.01 = 0.01

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:354

Default reverse bonding curve fee slippage factor (1%) - Applied to maxAcceptableReverseBondingCurveFee

DEFAULT_SLIPPAGE_TOLERANCE_FACTOR​

readonly static DEFAULT_SLIPPAGE_TOLERANCE_FACTOR: 0.15 = 0.15

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:352

Default slippage tolerance factor (15%) - Higher for volatile bonding curve tokens

events​

Get Signature​

get events(): EventsBatcherService

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:666

Access the events tracking service for batching and flushing events

Lazy-initialized on first access.

Since​

8.2.0

Returns​

EventsBatcherService

EventsBatcherService instance

burnTokens()​

burnTokens(data): Promise<BurnTokensResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8786

Permanently burn (destroy) tokens on GalaChain

⚠️ WARNING: THIS OPERATION IS IRREVERSIBLE!

Once tokens are burned, they are permanently destroyed and cannot be recovered. The burned tokens are removed from circulation, reducing total supply.

Supports batch burning of multiple token types in a single transaction.

Parameters​

data​

BurnTokensData

Burn tokens parameters

Returns​

Promise<BurnTokensResult>

BurnTokensResult with transaction details and burned token info

Examples​

Burn a single token by name

const result = await sdk.burnTokens({
  tokens: [{ tokenName: 'anime', amount: '1000' }]
});
console.log('Burned:', result.burned);

Burn multiple tokens in one transaction

const result = await sdk.burnTokens({
  tokens: [
    { tokenName: 'anime', amount: '500' },
    { tokenName: 'dragon', amount: '250' }
  ]
});
console.log('Burned:', result.burned.length, 'token types');

Burn by tokenId

const result = await sdk.burnTokens({
  tokens: [{
    tokenId: 'Token|Unit|ANIME|client:abc123',
    amount: '1000'
  }]
});

Throws​

When token cannot be found, insufficient balance, or burn fails

Throws​

When wallet is not configured

calculateBuyAmountForGraduation()​

calculateBuyAmountForGraduation(tokenNameOrOptions): Promise<GraduationCalculationResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7605

Calculate buy amount needed to graduate a token pool

Convenience method that fetches pool details and calculates the exact cost to buy all remaining tokens. Returns GraduationCalculationResult which includes remainingTokens (the token quantity to buy).

Performance optimization: Provide currentSupply to avoid fetching pool details twice.

Parameters​

tokenNameOrOptions​

string | CalculateBuyAmountForGraduationOptions

Token name string OR CalculateBuyAmountForGraduationOptions object

Returns​

Promise<GraduationCalculationResult>

Promise Calculation with remainingTokens for graduation

Throws​

ValidationError if token not found or already graduated

Examples​

Basic usage

const result = await sdk.calculateBuyAmountForGraduation('mytoken');
console.log('Tokens to buy:', result.remainingTokens); // Token quantity
console.log('GALA required:', result.amount);          // GALA cost

Performance-optimized with reused pool details

import { CALCULATION_MODES } from '@gala-chain/launchpad-sdk';

const poolDetails = await sdk.fetchPoolDetailsForCalculation('anime');
const result = await sdk.calculateBuyAmountForGraduation({
  tokenName: 'anime',
  calculateAmountMode: CALCULATION_MODES.LOCAL,
  currentSupply: poolDetails.currentSupply
});

claimModeratorInvite()​

claimModeratorInvite(options): Promise<ClaimModeratorInviteResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3840

Claim a moderator invite.

Claims an invite using the code from a magic link URL. The authenticated user's wallet becomes the moderator for the token with the specified role.

Requires JWT authentication.

Parameters​

options​

ClaimModeratorInviteOptions

Claim options including the invite code

Returns​

Promise<ClaimModeratorInviteResult>

The token that was added to the user's moderated tokens

Example​

const result = await sdk.claimModeratorInvite({
  inviteCode: 'abc123def456...'
});
console.log('Now moderating:', result.token.tokenName);
console.log('Role:', result.token.role);

Since​

5.7.0

convertTokenNameToTokenClassKey()​

convertTokenNameToTokenClassKey(tokenName): Promise<GalaChainTokenClassKey>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8663

Convert token name to TokenClassKey (explicit alias for resolveTokenClassKey)

CRITICAL: TokenClassKey is NOT Derivable from TokenName!​

This is an explicit alias emphasizing that resolution is REQUIRED - never guess.

The relationship between token name and TokenClassKey is NOT PREDICTABLE:

  • tokenName: "anime" does NOT mean type: "ANIME" (could be "ANM", "ANIM", etc.)
  • The additionalKey contains the creator's ETH address - impossible to guess

ALWAYS use this method. Never construct TokenClassKey manually from a token name.

Parameters​

tokenName​

string

Token name to convert (e.g., 'anime', 'dragon')

Returns​

Promise<GalaChainTokenClassKey>

Promise The resolved token class key (cached on subsequent calls)

Example​

// ✅ CORRECT - Always use this method
const tokenClassKey = await sdk.convertTokenNameToTokenClassKey('anime');
// Returns: { collection: "Token", category: "Unit", type: "ANM", additionalKey: "eth:0x..." }

// ❌ WRONG - Never do this!
const tokenClassKey = {
  collection: "Token",
  category: "Unit",
  type: "ANIME",        // WRONG! Might be "ANM" or anything
  additionalKey: "???"  // IMPOSSIBLE to guess!
};

Throws​

When token name cannot be resolved

createApiKey()​

createApiKey(options): Promise<CreateApiKeyResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3650

Create a new API key.

CRITICAL: The rawKey in the response is ONLY shown once! Store it securely immediately - it cannot be retrieved again.

API keys enable delegation of specific permissions to third-party services or automated systems without sharing full account access.

Requires JWT authentication - call sdk.login() first.

Parameters​

options​

CreateApiKeyOptions

API key creation options

Returns​

Promise<CreateApiKeyResponse>

Created API key with raw key (shown only once)

Throws​

ValidationError if options are invalid

Throws​

ConfigurationError if JWT auth is not configured

Example​

// Create a moderator key for chat management
const result = await sdk.createApiKey({
  role: 'MODERATOR',
  description: 'Twitch chat bot integration',
  tokenNames: ['mytoken', 'othertoken']
});

// CRITICAL: Save this immediately!
console.log('API Key:', result.rawKey);
// Format: glp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

// Create an owner key for full access to all tokens
const ownerKey = await sdk.createApiKey({
  role: 'OWNER',
  description: 'Production automation',
  delegateAllTokens: true,
  expiresAt: '2025-12-31T23:59:59Z'
});

Since​

5.6.0

createModeratorInvite()​

createModeratorInvite(options): Promise<CreateModeratorInviteResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3817

Create a moderator invite for a token.

Creates a magic link invite that can be shared with someone to grant them moderator access to the specified token. The recipient claims the invite after logging in, and their wallet becomes linked as a moderator.

Requires JWT authentication - must be the token owner.

Parameters​

options​

CreateModeratorInviteOptions

Create invite options including tokenName, role, and optional description/expiration

Returns​

Promise<CreateModeratorInviteResult>

The created invite including the magic link URL

Example​

const result = await sdk.createModeratorInvite({
  tokenName: 'mytoken',
  role: 'MODERATOR',
  description: 'John - Friday evening shows'
});
console.log('Share this link:', result.invite.inviteUrl);

Since​

5.7.0

emitBalanceUpdated()​

emitBalanceUpdated(userAddress, tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4640

Emit a balance update to a specific user (admin/overseer only)

Parameters​

userAddress​

string

tokenName​

string

payload​

BalanceUpdatedPayload

Returns​

Promise<void>

emitChatMessage()​

emitChatMessage(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4656

Emit chat message event (admin/overseer only)

Parameters​

tokenName​

string

payload​

ChatMessagePayload

Returns​

Promise<void>

emitChatStatus()​

emitChatStatus(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4660

Emit chat status event (admin/overseer only)

Parameters​

tokenName​

string

payload​

ChatStatusPayload

Returns​

Promise<void>

emitFeatureStatus()​

emitFeatureStatus(payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4692

Emit feature status changed event (admin/overseer only)

Parameters​

payload​

FeatureStatusPayload

Returns​

Promise<void>

emitModeratorAdded()​

emitModeratorAdded(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4676

Emit moderator added event (admin/overseer only)

Parameters​

tokenName​

string

payload​

ModeratorAddedPayload

Returns​

Promise<void>

emitModeratorRemoved()​

emitModeratorRemoved(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4680

Emit moderator removed event (admin/overseer only)

Parameters​

tokenName​

string

payload​

ModeratorRemovedPayload

Returns​

Promise<void>

emitSiteConfigChanged()​

emitSiteConfigChanged(payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4688

Emit site configuration changed event (admin/overseer only)

Parameters​

payload​

SiteConfigChangedPayload

Returns​

Promise<void>

emitStreamCountdown()​

emitStreamCountdown(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4652

Emit stream countdown event (admin/overseer only)

Parameters​

tokenName​

string

payload​

StreamCountdownPayload

Returns​

Promise<void>

emitStreamStatus()​

emitStreamStatus(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4644

Emit stream status change event (admin/overseer only)

Parameters​

tokenName​

string

payload​

StreamStatusPayload

Returns​

Promise<void>

emitTokenBanned()​

emitTokenBanned(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4668

Emit token banned event (admin/overseer only)

Parameters​

tokenName​

string

payload​

TokenBannedPayload

Returns​

Promise<void>

emitTokenUnbanned()​

emitTokenUnbanned(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4672

Emit token unbanned event (admin/overseer only)

Parameters​

tokenName​

string

payload​

TokenUnbannedPayload

Returns​

Promise<void>

emitTypingIndicator()​

emitTypingIndicator(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4664

Emit typing indicator event (admin/overseer only)

Parameters​

tokenName​

string

payload​

TypingIndicatorPayload

Returns​

Promise<void>

emitUserProfileUpdated()​

emitUserProfileUpdated(userAddress, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4684

Emit user profile updated event (admin/overseer only)

Parameters​

userAddress​

string

payload​

UserProfileUpdatedPayload

Returns​

Promise<void>

emitViewerCount()​

emitViewerCount(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4648

Emit viewer count update event (admin/overseer only)

Parameters​

tokenName​

string

payload​

ViewerCountPayload

Returns​

Promise<void>

fetchAvailableBalance()​

fetchAvailableBalance(options): Promise<AvailableBalanceResult | null>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7314

Fetch available (unlocked, not in-use) balance for a token

Returns the portion of balance that is not locked or in use. Requires tokenId (not tokenName) for accurate calculations with lock details.

Parameters​

options​

FetchTokenBalanceOptions

Balance query options

Returns​

Promise<AvailableBalanceResult | null>

Promise<AvailableBalanceResult | null> Available balance details or null if no balance

Example​

const available = await sdk.fetchAvailableBalance({
  address: sdk.getAddress(),
  tokenId: 'GALA|Unit|none|none'
});

if (available) {
  console.log('Total:', available.totalQuantity);
  console.log('Available:', available.availableQuantity);
}

fetchClientFlags()​

fetchClientFlags(): Promise<GetClientFlagsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5413

Get client feature flags.

Returns feature flag overrides for the native mobile app. No authentication required (public endpoint).

Returns​

Promise<GetClientFlagsResult>

Client feature flags

Example​

const { flags } = await sdk.fetchClientFlags();
console.log('Push notifications:', flags.PUSH_NOTIFICATIONS);
console.log('Dark mode:', flags.DARK_MODE);
console.log('DEX trading:', flags.DEX_TRADING);

fetchEthereumWalletAllBalances()​

fetchEthereumWalletAllBalances(address?): Promise<EthereumWalletBalanceResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2059

Fetch all supported token balances on Ethereum for a wallet.

Returns native ETH balance plus all supported ERC-20 token balances in a single call: GALA, GWETH, GUSDC, GUSDT, GWTRX, GWBTC

This method fetches all balances in parallel (7 RPC calls). For checking a single token, use fetchEthereumWalletTokenBalance() (more efficient).

Parameters​

address?​

string

Ethereum address (0x format). Defaults to configured wallet address.

Returns​

Promise<EthereumWalletBalanceResult>

Complete balance breakdown including native ETH and all supported tokens

Throws​

Error if Ethereum bridge is not configured

Examples​

Fetch all balances for configured wallet

const balances = await sdk.fetchEthereumWalletAllBalances();
console.log(`ETH: ${balances.native.quantity}`);
console.log(`GALA: ${balances.tokens.find(t => t.symbol === 'GALA')?.quantity}`);

Fetch all balances for specific address

const balances = await sdk.fetchEthereumWalletAllBalances('0x742d35Cc6634C0532925a3b8D0Ea2c76f94C31C0');
for (const token of balances.tokens) {
  console.log(`${token.symbol}: ${token.quantity}`);
}

fetchEthereumWalletNativeBalance()​

fetchEthereumWalletNativeBalance(address?): Promise<ExternalChainBalance>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1875

Fetch native ETH balance on Ethereum.

Efficient method for checking ETH balance only (1 RPC call). Use fetchEthereumWalletAllBalances() for complete portfolio view.

Parameters​

address?​

string

Ethereum address (0x format). Defaults to configured wallet.

Returns​

Promise<ExternalChainBalance>

Native ETH balance with metadata

Throws​

Error if Ethereum bridge is not configured

Example​

Check ETH balance (for gas fees)

const eth = await sdk.fetchEthereumWalletNativeBalance();
console.log(`ETH for gas: ${eth.quantity}`);

fetchEthereumWalletTokenBalance()​

fetchEthereumWalletTokenBalance(symbol, address?): Promise<ExternalChainBalance>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1858

Fetch a single ERC-20 token balance on Ethereum.

Efficient method for checking a specific token balance (1 RPC call). Use fetchEthereumWalletAllBalances() for complete portfolio view.

Parameters​

symbol​

string

Token symbol (GALA, GWETH, GUSDC, GUSDT, GWTRX, GWBTC)

address?​

string

Ethereum address (0x format). Defaults to configured wallet.

Returns​

Promise<ExternalChainBalance>

Single token balance with metadata

Throws​

Error if Ethereum bridge is not configured or token is not supported

Examples​

Check GALA balance on Ethereum

const gala = await sdk.fetchEthereumWalletTokenBalance('GALA');
console.log(`GALA on Ethereum: ${gala.quantity}`);

Check specific address

const gusdc = await sdk.fetchEthereumWalletTokenBalance('GUSDC', '0x742d35Cc...');
console.log(`GUSDC: ${gusdc.quantity} (${gusdc.decimals} decimals)`);

fetchLaunchTokenFee()​

fetchLaunchTokenFee(): Promise<number>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1188

Fetch the current launchpad token launch fee

Returns the GALA fee amount required to launch a new token. This fee is dynamic and may vary based on network conditions. Call this before launching a token to ensure you have sufficient balance. Served by the launchpad backend (GET /v1/trading/fee, cached 1 hour); identical to LaunchpadSDK.fetchLaunchpadFee.

Returns​

Promise<number>

Promise The current launch fee in GALA (e.g., 0.001)

Throws​

Network errors from connection failures or timeouts

Throws​

If the backend returns an error response

Example​

const fee = await sdk.fetchLaunchTokenFee();
console.log(`Token launch fee: ${fee} GALA`);

// Check if wallet has sufficient balance
const balance = await sdk.fetchGalaBalance();
if (parseFloat(balance.quantity) >= fee) {
  console.log('Sufficient balance to launch token');
}

fetchLockedBalance()​

fetchLockedBalance(options): Promise<LockedBalanceResult | null>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7291

Fetch only locked balance for a token

Returns focused information about locked tokens including lock details. Requires tokenId (not tokenName) as lock details are only available from GalaChain.

Parameters​

options​

FetchTokenBalanceOptions

Balance query options (must include tokenId, not tokenName)

Returns​

Promise<LockedBalanceResult | null>

Promise<LockedBalanceResult | null> Locked balance details or null if no balance

Throws​

Error if tokenName is provided (lock details require tokenId)

Example​

const locked = await sdk.fetchLockedBalance({
  address: sdk.getAddress(),
  tokenId: 'GALA|Unit|none|none'
});

if (locked) {
  console.log('Locked quantity:', locked.lockedQuantity);
  locked.lockedHolds.forEach(hold => {
    console.log(`Lock by ${hold.lockAuthority}: ${hold.quantity}`);
  });
}

fetchNotificationPreferences()​

fetchNotificationPreferences(): Promise<GetNotificationPreferencesResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5376

Get notification preferences for the authenticated user.

Returns the current push notification preference settings.

Authentication: Requires JWT auth (call sdk.login() first).

Returns​

Promise<GetNotificationPreferencesResult>

Current notification preferences

Example​

const { preferences } = await sdk.fetchNotificationPreferences();
console.log('Trades:', preferences.tradesEnabled);
console.log('Streams:', preferences.streamsEnabled);
console.log('Chat:', preferences.chatEnabled);
console.log('System:', preferences.systemEnabled);

fetchPoolDetails()​

fetchPoolDetails(tokenName): Promise<PoolDetailsData>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1236

Fetch pool details for a token - returns complete bonding curve pool state

Delegates to fetchPoolDetailsForCalculation for normalized fee factors and computed values, then enriches with full pool data from the launchpad backend.

Parameters​

tokenName​

string

Token name to fetch pool details for

Returns​

Promise<PoolDetailsData>

Promise

fetchSolanaWalletAllBalances()​

fetchSolanaWalletAllBalances(address?): Promise<SolanaWalletBalanceResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2088

Fetch all supported token balances on Solana for a wallet.

Returns native SOL balance plus all supported SPL token balances in a single call: GALA, GSOL

This method fetches all balances in parallel (3 RPC calls). For checking a single token, use fetchSolanaWalletTokenBalance() (more efficient).

Parameters​

address?​

string

Solana address (base58 format). Defaults to configured wallet address.

Returns​

Promise<SolanaWalletBalanceResult>

Complete balance breakdown including native SOL and all supported tokens

Throws​

Error if Solana bridge is not configured

Examples​

Fetch all balances for configured wallet

const balances = await sdk.fetchSolanaWalletAllBalances();
console.log(`SOL: ${balances.native.quantity}`);
console.log(`GALA: ${balances.tokens.find(t => t.symbol === 'GALA')?.quantity}`);

Fetch all balances for specific address

const balances = await sdk.fetchSolanaWalletAllBalances('7dMM...base58address');
for (const token of balances.tokens) {
  console.log(`${token.symbol}: ${token.quantity}`);
}

fetchSolanaWalletNativeBalance()​

fetchSolanaWalletNativeBalance(address?): Promise<ExternalChainBalance>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1910

Fetch native SOL balance on Solana.

Efficient method for checking SOL balance only (1 RPC call). Use fetchSolanaWalletAllBalances() for complete portfolio view.

Parameters​

address?​

string

Solana address (base58 format). Defaults to configured wallet.

Returns​

Promise<ExternalChainBalance>

Native SOL balance with metadata

Throws​

Error if Solana bridge is not configured

Example​

Check SOL balance (for transaction fees)

const sol = await sdk.fetchSolanaWalletNativeBalance();
console.log(`SOL for fees: ${sol.quantity}`);

fetchSolanaWalletTokenBalance()​

fetchSolanaWalletTokenBalance(symbol, address?): Promise<ExternalChainBalance>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1893

Fetch a single SPL token balance on Solana.

Efficient method for checking a specific token balance (1 RPC call). Use fetchSolanaWalletAllBalances() for complete portfolio view.

Parameters​

symbol​

string

Token symbol (GALA, GSOL)

address?​

string

Solana address (base58 format). Defaults to configured wallet.

Returns​

Promise<ExternalChainBalance>

Single token balance with metadata

Throws​

Error if Solana bridge is not configured or token is not supported

Example​

Check GALA balance on Solana

const gala = await sdk.fetchSolanaWalletTokenBalance('GALA');
console.log(`GALA on Solana: ${gala.quantity}`);

fetchTokenBalance()​

fetchTokenBalance(options): Promise<TokenBalanceResult | null>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7265

Fetch token balance from GalaChain (published tokens) or DEX API (launchpad tokens)

This method queries either the GalaChain gateway directly for published tokens or the DEX API for launchpad tokens, providing reliable results.

Parameters​

options​

FetchTokenBalanceOptions

Token balance options with flexible token identification

Returns​

Promise<TokenBalanceResult | null>

Promise<TokenBalanceResult | null>

Example​

// Using string format
const galaBalance = await sdk.fetchTokenBalance({
  address: sdk.getAddress(),
  tokenId: "GALA|Unit|none|none"
});

// Using TokenClassKey object
const tokenClass = await sdk.resolveTokenClassKey('unicorn');
const unicornBalance = await sdk.fetchTokenBalance({
  address: sdk.getAddress(),
  tokenClassKey: tokenClass
});

// Using TokenInstanceKey object
const unicornBalance2 = await sdk.fetchTokenBalance({
  address: sdk.getAddress(),
  tokenId: {
    collection: "Token",
    category: "Unit",
    type: "UNI",
    additionalKey: "eth:9401b171307bE656f00F9e18DF756643FD3a91dE",
    instance: "0"
  }
});

// Using token name for convenience
const unicornBalance3 = await sdk.fetchTokenBalance({
  address: sdk.getAddress(),
  tokenName: "unicorn"
});

fetchTokenDetails()​

fetchTokenDetails(tokenId): Promise<GalaChainTokenDetails>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1162

Fetch comprehensive token details from GalaChain

Reads the token's GalaChain token class (symbol, decimals, name, image, description, network, contract address).

Supports flexible token identification using either string or object format:

  • String: 'GUSDC|Unit|none|eth:0x...' (pipe-delimited)
  • Object: { collection, category, type, additionalKey }

Parameters​

tokenId​

TokenId

Token identifier in flexible format

Returns​

Promise<GalaChainTokenDetails>

Promise The token class's details (gala-core-sdk's type)

Examples​

String format

const details = await sdk.fetchTokenDetails('GUSDC|Unit|none|none');
console.log(details.symbol);      // 'GUSDC'
console.log(details.decimals);    // 6
console.log(details.network);     // the token's network
console.log(details.image);       // 'https://...'

Object format

const details = await sdk.fetchTokenDetails({
  collection: 'GUSDC',
  category: 'Unit',
  type: 'none',
  additionalKey: 'none'
});

Throws​

If tokenId format is invalid

Throws​

If API request fails or token not found

fetchTokenPrice()​

fetchTokenPrice(params): Promise<TokenSpotPrice>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1126

Fetch a launchpad token's USD spot price.

  • A token still on its bonding curve: GALA's USD price divided by the tokens 1 GALA buys (the launchpad backend's bonding-curve calculation).
  • A graduated token: its USD price on the swap backend.

Only launchpad tokens (by name) are priced here. Any token by class key, and GALA itself, is priced by gswap-sdk: gSwap.market.getPrice('GALA|Unit|none|none').

Parameters​

params​

FetchTokenSpotPriceParams

The launchpad token's name

Returns​

Promise<TokenSpotPrice>

Promise The token's symbol and USD price

Example​

const price = await sdk.fetchTokenPrice({ tokenName: 'galadog' });
console.log(`${price.symbol}: $${price.price.toFixed(6)}`);

Throws​

ValidationError if tokenName is missing or empty, or a tokenId is given

Throws​

NetworkError if the calculation or a price read fails

fetchTokensCreated()​

fetchTokensCreated(options?): Promise<UserTokenListResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8469

Fetch tokens created by the current user with optional filtering

Retrieves a paginated list of tokens created by the authenticated user. Uses backend search, then applies exact tokenName matching to the returned page.

Parameters​

options?​

FetchTokensCreatedOptions

Token list options with filtering support

Returns​

Promise<UserTokenListResult>

Promise User's created tokens with pagination metadata

Example​

// Fetch all created tokens with pagination
const myTokens = await sdk.fetchTokensCreated({ pageSize: 20 });

// Exact match for a specific created token (most efficient)
const myToken = await sdk.fetchTokensCreated({ tokenName: 'mytoken', pageSize: 1 });

// Fuzzy search through created tokens
const testTokens = await sdk.fetchTokensCreated({ search: 'test', pageSize: 10 });

Remarks​

  • Use tokenName for exact lookups when you know the token name (fastest)
  • Use search for discovery when exploring your created tokens
  • search is applied by the backend; tokenName is matched locally
  • If both are supplied, the returned page must satisfy both filters

fetchTokensHeld()​

fetchTokensHeld(options?): Promise<UserTokenListResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8438

Fetch tokens held by user with optional filtering

Retrieves a paginated list of tokens held by the authenticated user. Uses backend search and exact tokenName filters for holdings.

Parameters​

options?​

FetchTokensHeldOptions

Token list options with filtering support

Returns​

Promise<UserTokenListResult>

Promise User's token holdings with pagination metadata

Example​

// Fetch all tokens with pagination
const allTokens = await sdk.fetchTokensHeld({ pageSize: 20 });

// Exact match for a specific token (most efficient)
const anime = await sdk.fetchTokensHeld({ tokenName: 'anime', pageSize: 1 });

// Fuzzy search for exploration
const dragons = await sdk.fetchTokensHeld({ search: 'dragon', pageSize: 10 });

Remarks​

  • Use tokenName for exact lookups when you know the token name (fastest)
  • Use search for discovery when exploring available tokens
  • Both filters are applied by the backend
  • Passing both parameters together is discouraged

getApiKey()​

getApiKey(id): Promise<ApiKeyData>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3711

Get a single API key by ID.

Returns the API key metadata. Raw key is never included.

Requires JWT authentication - call sdk.login() first.

Parameters​

id​

number

API key ID

Returns​

Promise<ApiKeyData>

API key data

Throws​

ValidationError if ID is invalid

Throws​

ConfigurationError if JWT auth is not configured

Throws​

Error if API key not found (404)

Example​

const key = await sdk.getApiKey(123);
console.log(`Key ${key.keyPrefix}: ${key.role}`);
console.log(`Description: ${key.description}`);
console.log(`Delegate all tokens: ${key.delegateAllTokens}`);
console.log(`Token names: ${key.tokenNames.join(', ')}`);

Since​

5.6.0

getApiKeyRoles()​

getApiKeyRoles(): string[]

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3792

Get all valid API key roles.

Returns the list of available roles for API keys. Useful for UI dropdowns or validation.

Returns​

string[]

Array of valid role strings

Example​

const roles = sdk.getApiKeyRoles();
console.log('Available roles:', roles);
// ['MODERATOR', 'TECHNICAL_PRODUCER', 'MANAGER', 'OWNER']

Since​

5.6.0

getBundlerTransactionResult()​

getBundlerTransactionResult(transactionId): Promise<ApiResponse<unknown>>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7868

Get bundle transaction result

Returns a lightweight status check for a bundle transaction via HTTP (not WebSocket). Useful for checking transaction status when WebSocket monitoring times out or to get a definitive answer on transaction state.

Response format: { id: string, method: string, status: string }

Parameters​

transactionId​

string

Transaction ID from buy(), sell(), or launchToken()

Returns​

Promise<ApiResponse<unknown>>

Promise with transaction result containing id, method, and status

Example​

// Check status of a transaction
const result = await sdk.getBundlerTransactionResult('3c7d9f79-a496-4794-abaf-d6bd13473ff7');

console.log('Status:', result.data.status); // "COMPLETED", "FAILED", "PENDING", "PROCESSING"
console.log('Method:', result.data.method); // "SellExactToken", "BuyWithNative", etc.

getConnectedClients()​

getConnectedClients(options?): Promise<ConnectedClientsResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4723

Get list of currently connected WebSocket clients (admin/overseer only)

Parameters​

options?​

GetConnectedClientsOptions

Returns​

Promise<ConnectedClientsResponse>

getEthereumTransactionStatus()​

getEthereumTransactionStatus(transactionHash): Promise<EthereumTransactionStatus>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2030

Get the status of an Ethereum transaction by hash.

Queries Ethereum RPC directly using getTransactionReceipt() and getTransaction(). Use this to verify if a bridge or any Ethereum transaction succeeded after submission.

Status values:

  • pending - Transaction in mempool, not yet mined
  • confirmed - Mined with <12 confirmations
  • finalized - Mined with 12+ confirmations (practical finality)
  • not_found - Transaction hash not found on network
  • failed - Transaction mined but reverted

Performance: Single synchronous RPC call sequence (no WebSocket required).

Parameters​

transactionHash​

string

Ethereum transaction hash (0x + 64 hex characters)

Returns​

Promise<EthereumTransactionStatus>

Transaction status with confirmation details

Throws​

Error if Ethereum bridge is not configured or hash format invalid

Examples​

Check bridge transaction status

const bridgeResult = await sdk.bridgeOut({
  tokenId: 'GALA|Unit|none|none',
  amount: '100',
  destinationChain: 'Ethereum',
  recipientAddress: '0x1234...',
});

const status = await sdk.getEthereumTransactionStatus(bridgeResult.transactionHash);
console.log(`Status: ${status.status}`);
console.log(`Confirmations: ${status.confirmations}`);
if (status.status === 'finalized') {
  console.log('Transaction is final (12+ confirmations)');
}

Polling pattern for finality

async function waitForFinality(txHash: string, maxAttempts = 30) {
  for (let i = 0; i < maxAttempts; i++) {
    const status = await sdk.getEthereumTransactionStatus(txHash);
    if (status.status === 'finalized') return status;
    if (status.status === 'failed') throw new Error(status.error);
    await new Promise(r => setTimeout(r, 15000)); // ~15s per block
  }
  throw new Error('Transaction finality timeout');
}

getModeratedTokens()​

getModeratedTokens(options?): Promise<ModeratedTokensResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3863

Get all tokens the current user moderates.

Returns a paginated list of tokens where the authenticated user has claimed a moderator invite and has active access. Used for the /studio dashboard.

Requires JWT authentication.

Parameters​

options?​

BasePaginationOptions

Optional pagination options

Returns​

Promise<ModeratedTokensResult>

Paginated list of moderated tokens

Example​

const result = await sdk.getModeratedTokens({ pageSize: 20 });
console.log('Moderating', result.pageInfo.totalCount, 'tokens');
for (const token of result.tokens) {
  console.log(`- ${token.tokenName} (${token.role})`);
}

Since​

5.7.0

getModeratorInviteByCode()​

getModeratorInviteByCode(inviteCode): Promise<PublicInviteInfo>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3995

Get invite details by code (public endpoint).

Returns public information about an invite for the claim page. This is used by the frontend to display invite details before the user logs in to claim.

No authentication required.

Parameters​

inviteCode​

string

The invite code from the magic link URL

Returns​

Promise<PublicInviteInfo>

Public invite information

Example​

const info = await sdk.getModeratorInviteByCode('abc123def456...');
console.log(`Invited to moderate ${info.tokenName} as ${info.role}`);
console.log(`Invited by: ${info.invitedBy.fullName || info.invitedBy.address}`);

Since​

5.7.0

getOnlineOverseers()​

getOnlineOverseers(): Promise<{ clients: ConnectedClient[]; count: number; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4772

Get list of currently online overseers/admins

Returns​

Promise<{ clients: ConnectedClient[]; count: number; }>

getOnlineUsers()​

getOnlineUsers(userAddresses): Promise<{ clients: object[]; offline: string[]; online: string[]; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4746

Batch check which users from a list are currently online

Parameters​

userAddresses​

string[]

Array of user wallet addresses (required, non-empty)

Returns​

Promise<{ clients: object[]; offline: string[]; online: string[]; }>

Object with online/offline arrays and client details

Throws​

ConfigurationError if userAddresses is empty or invalid

Throws​

NetworkError if API request fails

getSolanaTransactionStatus()​

getSolanaTransactionStatus(signature): Promise<SolanaTransactionStatus>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1980

Get the status of a Solana transaction by signature.

This method queries the Solana RPC directly using getSignatureStatuses, which doesn't require WebSockets and works in Node.js environments. Use this to verify airdrop or bridge transactions after submission.

Requirements:

  • Solana private key must be configured (solanaPrivateKey in config)

Parameters​

signature​

string

Base58-encoded Solana transaction signature (87-88 characters)

Returns​

Promise<SolanaTransactionStatus>

Transaction status with:

  • confirmed: Whether transaction has been successfully processed on-chain
  • status: Confirmation level ('confirmed' | 'finalized' | 'processed' | 'not_found' | 'failed')
  • slot: Block slot number (present when transaction is found)
  • error: Error details if transaction failed

Throws​

Error if Solana bridge not configured or signature format is invalid

Examples​

Check airdrop status

const signature = await sdk.requestSolanaDevnetAirdrop(1);
// Wait a moment for transaction to propagate
await new Promise(r => setTimeout(r, 2000));
const status = await sdk.getSolanaTransactionStatus(signature);
if (status.confirmed) {
  console.log(`Confirmed at slot ${status.slot}, level: ${status.status}`);
} else if (status.status === 'not_found') {
  console.log('Transaction not yet visible, try again');
} else if (status.status === 'failed') {
  console.log(`Transaction failed: ${status.error}`);
}

Polling pattern for confirmation

async function waitForConfirmation(signature: string, maxAttempts = 30) {
  for (let i = 0; i < maxAttempts; i++) {
    const status = await sdk.getSolanaTransactionStatus(signature);
    if (status.confirmed) return status;
    if (status.status === 'failed') throw new Error(status.error);
    await new Promise(r => setTimeout(r, 2000));
  }
  throw new Error('Transaction confirmation timeout');
}

getTokenViewers()​

getTokenViewers(tokenName, options?): Promise<{ authenticatedCount: number; clients: ConnectedClient[]; count: number; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4761

Get list of users currently viewing a specific token

Parameters​

tokenName​

string

Token name

options?​

Optional filtering options

authenticated?​

boolean

limit?​

number

Returns​

Promise<{ authenticatedCount: number; clients: ConnectedClient[]; count: number; }>

getWalletProvider()​

getWalletProvider(): WalletProvider | undefined

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:672

Returns the configured wallet provider (if any)

Returns​

WalletProvider | undefined

The wallet provider or undefined if not configured

graduateToken()​

graduateToken(options): Promise<TradeResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7641

Graduate a token pool by buying all remaining tokens

Convenience method that combines calculateBuyAmountForGraduation + buy to graduate a token in a single call with WebSocket confirmation.

Performance optimization: Provide currentSupply to avoid fetching pool details twice.

Parameters​

options​

GraduateTokenOptions

Graduation options with tokenName and optional slippage protection

Returns​

Promise<TradeResult>

Promise Transaction result from buying all remaining tokens

Throws​

ValidationError if token already graduated or parameters invalid

Examples​

Basic usage

const result = await sdk.graduateToken({
  tokenName: 'mytoken',
  slippageToleranceFactor: 0.01
});
console.log('Graduation complete!');
console.log('Total cost:', result.totalFees);

Performance-optimized with reused pool details

import { CALCULATION_MODES } from '@gala-chain/launchpad-sdk';

const poolDetails = await sdk.fetchPoolDetailsForCalculation('anime');
const result = await sdk.graduateToken({
  tokenName: 'anime',
  calculateAmountMode: CALCULATION_MODES.LOCAL,
  currentSupply: poolDetails.currentSupply,
  slippageToleranceFactor: 0.01
});

isUserOnline()​

isUserOnline(userAddress): Promise<{ connectedAt?: string; online: boolean; rooms?: string[]; socketId?: string; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4732

Check if a specific user is currently online

Parameters​

userAddress​

string

User's wallet address (required, non-empty)

Returns​

Promise<{ connectedAt?: string; online: boolean; rooms?: string[]; socketId?: string; }>

Online status with socket ID and rooms if connected

Throws​

ConfigurationError if userAddress is empty

Throws​

NetworkError if API request fails

listApiKeys()​

listApiKeys(options?): Promise<ApiKeyListResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3686

List all API keys for the authenticated user.

Returns paginated list of API keys. Raw keys are never included - they are only shown once at creation time.

Requires JWT authentication - call sdk.login() first.

Parameters​

options?​

ListApiKeysOptions

Optional pagination options

Returns​

Promise<ApiKeyListResponse>

Paginated list of API keys

Throws​

ConfigurationError if JWT auth is not configured

Example​

// List all API keys
const result = await sdk.listApiKeys();
console.log(`Total keys: ${result.pageInfo.totalCount}`);

for (const key of result.apiKeys) {
  console.log(`${key.keyPrefix} - ${key.role} - ${key.description}`);
  console.log(`  Last used: ${key.lastUsedAt || 'Never'}`);
  console.log(`  Expires: ${key.expiresAt || 'Never'}`);
}

// Paginate through keys (cursor-based)
if (result.pageInfo.hasNextPage) {
  const page2 = await sdk.listApiKeys({
    cursor: result.pageInfo.endCursor ?? undefined,
    pageSize: 10
  });
}

Since​

5.6.0

listModeratorInvites()​

listModeratorInvites(options): Promise<ModeratorInviteListResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3894

List moderator invites.

Returns a paginated list of moderator invites. Behavior depends on tokenName:

  • With tokenName: Returns invites for that specific token (verifies ownership)
  • Without tokenName: Returns ALL invites created by the authenticated user across all tokens

Requires JWT authentication.

Parameters​

options​

ListModeratorInvitesOptions

List options including optional tokenName, status filter, and pagination

Returns​

Promise<ModeratorInviteListResult>

Paginated list of invites

Example​

// Get all invites across all tokens
const allInvites = await sdk.listModeratorInvites({});

// Get invites for a specific token
const result = await sdk.listModeratorInvites({ tokenName: 'mytoken' });
console.log('Total invites:', result.pageInfo.totalCount);

// Filter by status
const pending = await sdk.listModeratorInvites({
  tokenName: 'mytoken',
  status: 'PENDING'
});

Since​

5.7.0

lockTokens()​

lockTokens(data): Promise<LockTokensResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8701

Lock tokens on GalaChain (batch operation)

Supports locking multiple token types in a single transaction. Places holds on tokens, preventing them from being transferred until unlocked. Useful for staking, escrow, vesting, or other hold scenarios.

The lock operation creates a hold that can only be released by the lock authority (defaults to the caller's address if not specified).

Parameters​

data​

LockTokensData

Lock tokens parameters

Returns​

Promise<LockTokensResult>

LockTokensResult with transaction ID and locked token details

Examples​

Lock a single token

const result = await sdk.lockTokens({
  tokens: [{ tokenName: 'anime', amount: '1000' }]
});
console.log('Tokens locked:', result.locked);

Lock multiple tokens with different settings

const result = await sdk.lockTokens({
  tokens: [
    { tokenName: 'anime', amount: '500', lockAuthority: 'eth|1234...' },
    { tokenName: 'dragon', amount: '250', expires: Date.now() + 86400000, name: 'vesting-lock' }
  ]
});

Throws​

When validation fails or lock operation is rejected

Throws​

When wallet is not configured

registerPushToken()​

registerPushToken(params): Promise<RegisterPushTokenResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5340

Register a push notification device token.

Associates a push token (FCM or APNs) with the authenticated user. If the token already exists, it updates the associated device info.

Authentication: Requires JWT auth (call sdk.login() first).

Parameters​

params​

RegisterPushTokenParams

Registration parameters (token, platform, optional deviceId)

Returns​

Promise<RegisterPushTokenResult>

Registration result

Example​

const result = await sdk.registerPushToken({
  token: 'fcm-device-token-abc123',
  platform: 'android',
  deviceId: 'pixel-7-main',
});
console.log('Registered:', result.registered);

requestSolanaDevnetAirdrop()​

requestSolanaDevnetAirdrop(amount?, address?): Promise<string>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1933

Request SOL airdrop from Solana devnet faucet.

Only available in stage environment (Solana devnet) for testing purposes. Will throw an error if called in production environment.

Parameters​

amount?​

number

Amount of SOL to request (default: 1, max: 2 per request)

address?​

string

Optional recipient Solana address (defaults to configured wallet)

Returns​

Promise<string>

Transaction signature

Throws​

Error if not in stage environment, Solana not configured, or airdrop fails

Examples​

Airdrop 1 SOL to configured wallet

const signature = await sdk.requestSolanaDevnetAirdrop();
console.log(`Airdrop complete: ${signature}`);

Airdrop specific amount to another address

const signature = await sdk.requestSolanaDevnetAirdrop(0.5, 'SomeAddress...');

resolveTokenClassKey()​

resolveTokenClassKey(tokenName): Promise<GalaChainTokenClassKey>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8629

Resolve token class key from token name

Public method to resolve a token name to its TokenClassKey object for caching or optimization patterns. Uses the same resolution logic as transferToken internally.

Parameters​

tokenName​

string

Token name to resolve (e.g., 'unicorn', 'tinyevil')

Returns​

Promise<GalaChainTokenClassKey>

Promise The resolved token class key object

Example​

const tokenClassKey = await sdk.resolveTokenClassKey('unicorn');
// Returns: {
//   collection: "Token",
//   category: "Unit",
//   type: "UNI",
//   additionalKey: "eth:9401b171307bE656f00F9e18DF756643FD3a91dE"
// }

// Can be cached and used later for direct operations
await sdk.transferToken({
  to: 'eth|...',
  tokenId: tokenClassKey, // Direct, no lookup
  amount: '1'
});

await sdk.fetchTokenBalance({
  address: sdk.getAddress(),
  tokenClassKey: tokenClassKey // Same object format
});

Throws​

When token name cannot be resolved

revokeApiKey()​

revokeApiKey(id): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3774

Revoke an API key.

This performs a soft delete - the key becomes immediately unusable but is retained for audit purposes.

Requires JWT authentication - call sdk.login() first.

Parameters​

id​

number

API key ID to revoke

Returns​

Promise<void>

Throws​

ValidationError if ID is invalid

Throws​

ConfigurationError if JWT auth is not configured

Throws​

Error if API key not found (404)

Example​

// Revoke a compromised key
await sdk.revokeApiKey(123);
console.log('API key revoked');

// Key is now unusable
// Attempts to use it will fail with 401 Unauthorized

Since​

5.6.0

revokeModeratorInvite()​

revokeModeratorInvite(inviteId): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3933

Revoke a moderator invite.

Revokes an invite by ID, preventing it from being claimed. If already claimed, the moderator loses access to the token.

Requires JWT authentication - must be the token owner.

Parameters​

inviteId​

number

The ID of the invite to revoke

Returns​

Promise<void>

Example​

await sdk.revokeModeratorInvite(123);
console.log('Invite revoked');

Since​

5.7.0

sell()​

sell(options): Promise<TradeResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7846

Sell tokens with confirmation

Executes a sell order on the bonding curve and waits for blockchain confirmation, returning complete trade details including actual amounts traded and fees paid.

Token Format​

Use simple tokenName (e.g., "anime"), NOT full TokenClassKey format.

This method is for bonding curve tokens only (pre-graduation). For DEX trading of graduated tokens, use @gala-chain/gswap-sdk (new GSwap({ signer }).swaps.swap()) with full TokenClassKey format.

// ✅ CORRECT - Simple token name
await sdk.sell({ tokenName: 'anime', amount: '100', type: 'tokens', ... });

// ❌ WRONG - Do NOT use TokenClassKey format
await sdk.sell({ tokenName: 'Token|Unit|ANIME|...' }); // Error!

Parameters​

options​

SellTokenOptions

Sell options with required tokenName and expectedAmount

Returns​

Promise<TradeResult>

Promise Complete trade result with amounts and fees

Since​

3.0.0 - Now returns TradeResult instead of basic response

Example​

const result = await sdk.sell({
  tokenName: 'mytoken',
  amount: '500',
  type: 'exact',
  expectedAmount: '50',
  slippageToleranceFactor: 0.05
});

console.log('Sold tokens:', result.inputAmount);
console.log('Received GALA:', result.outputAmount);
console.log('Fees paid:', result.totalFees);

setWalletProvider()​

setWalletProvider(provider): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:623

Sets or updates the wallet provider for authentication

Use this method to dynamically configure wallet authentication after SDK initialization. This is the preferred method for browser wallet integrations.

Parameters​

provider​

WalletProvider | undefined

The wallet provider to set (or undefined to clear)

Returns​

void

Example​

import { ExternalWalletProvider, detectWallets } from '@gala-chain/gala-core-sdk/providers';

// Detect available wallets
const { wallets } = await detectWallets();

// Create provider from detected wallet
const provider = new ExternalWalletProvider(wallets[0].provider);
await provider.connect();

// Set on SDK
sdk.setWalletProvider(provider);

transferGala()​

transferGala(data): Promise<GalaChainTransferReceipt>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8571

Transfer GALA tokens between wallets

Transfers GALA tokens from the authenticated wallet to another wallet using GalaChain with EIP-712 signature authentication.

Parameters​

data​

TransferGalaData

Transfer data including recipient address and amount

Returns​

Promise<GalaChainTransferReceipt>

Promise real chain transactionId (x-transaction-id header) and optional blockNumber (x-block-number)

Example​

// Transfer 1 GALA to another wallet
const { transactionId, blockNumber } = await sdk.transferGala({
  recipientAddress: 'eth|1234567890abcdef1234567890abcdef12345678',
  amount: '1' // 1 GALA in decimal format
});

console.log('GALA transfer successful!');
console.log('Transaction ID:', transactionId, 'block:', blockNumber);
// mainnet explorer: https://chainmeter.net/tx/index.html?tx=${transactionId}

transferToken()​

transferToken(data): Promise<GalaChainTransferReceipt>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8594

Transfer launchpad tokens between wallets

Transfers launchpad tokens from the authenticated wallet to another wallet using GalaChain with EIP-712 signature authentication.

Parameters​

data​

TransferTokenData

Transfer data including recipient address, token name, and amount

Returns​

Promise<GalaChainTransferReceipt>

Promise real chain transactionId + optional blockNumber

Example​

// Transfer 100 TINYEVIL tokens to another wallet
const { transactionId, blockNumber } = await sdk.transferToken({
  to: 'eth|9876543210fedcba9876543210fedcba98765432',
  tokenName: 'tinyevil',
  amount: '100' // Amount in decimal format
});

console.log('Token transfer successful!');
console.log('Transaction ID:', transactionId, 'block:', blockNumber);

unlockTokens()​

unlockTokens(data): Promise<UnlockTokensResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8737

Unlock previously locked tokens on GalaChain (batch operation)

Supports unlocking multiple token types in a single transaction. Releases token holds, making them available for transfer again. Must be signed by the lock authority (the address that locked the tokens or was designated as lock authority during the lock operation).

Parameters​

data​

UnlockTokensData

Unlock tokens parameters

Returns​

Promise<UnlockTokensResult>

UnlockTokensResult with transaction ID and unlocked token details

Examples​

Unlock a single token

const result = await sdk.unlockTokens({
  tokens: [{ tokenName: 'anime', amount: '1000' }]
});
console.log('Tokens unlocked:', result.unlocked);

Unlock multiple tokens

const result = await sdk.unlockTokens({
  tokens: [
    { tokenName: 'anime', amount: '500' },
    { tokenName: 'dragon', amount: '250', name: 'vesting-lock' }
  ]
});

Throws​

When validation fails or unlock operation is rejected

Throws​

When wallet is not configured

unregisterPushToken()​

unregisterPushToken(token): Promise<UnregisterPushTokenResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5357

Unregister a push notification device token.

Deactivates a push token so the device no longer receives notifications.

Authentication: Requires JWT auth (call sdk.login() first).

Parameters​

token​

string

The push token to unregister

Returns​

Promise<UnregisterPushTokenResult>

Unregistration result

Example​

const result = await sdk.unregisterPushToken('fcm-device-token-abc123');
console.log('Unregistered:', result.unregistered);

updateApiKey()​

updateApiKey(id, options): Promise<ApiKeyData>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3748

Update an API key's metadata and permissions.

Cannot change the key itself, only metadata and permissions. At least one field must be provided.

Requires JWT authentication - call sdk.login() first.

Parameters​

id​

number

API key ID

options​

UpdateApiKeyOptions

Fields to update

Returns​

Promise<ApiKeyData>

Updated API key data

Throws​

ValidationError if ID or options are invalid

Throws​

ConfigurationError if JWT auth is not configured

Throws​

Error if API key not found (404)

Example​

// Update description
await sdk.updateApiKey(123, {
  description: 'Updated description'
});

// Upgrade role and extend expiration
await sdk.updateApiKey(123, {
  role: 'MANAGER',
  expiresAt: '2026-12-31T23:59:59Z'
});

// Switch from specific tokens to all tokens
await sdk.updateApiKey(123, {
  delegateAllTokens: true
});

Since​

5.6.0

updateModeratorInvite()​

updateModeratorInvite(options): Promise<UpdateModeratorInviteResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3974

Update a moderator invite's role and/or description (owner only).

Parameters​

options​

UpdateModeratorInviteOptions

Update options including inviteId, optional role, and optional description

Returns​

Promise<UpdateModeratorInviteResult>

The updated invite

Example​

const result = await sdk.updateModeratorInvite({
  inviteId: 123,
  description: 'John - handles Friday evening streams'
});
console.log('Updated description:', result.invite.description);

Since​

5.0.4-beta.60

updateModeratorInviteRole()​

updateModeratorInviteRole(options): Promise<UpdateInviteRoleResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3956

Update the role of a moderator invite.

Changes the role granted by the invite. For claimed invites, the moderator's effective permissions change immediately (enforced at runtime).

Requires JWT authentication - must be the token owner.

Parameters​

options​

UpdateInviteRoleOptions

Update options including inviteId and new role

Returns​

Promise<UpdateInviteRoleResult>

The updated invite

Example​

const result = await sdk.updateModeratorInviteRole({
  inviteId: 123,
  role: 'MANAGER'
});
console.log('Updated role:', result.invite.role);

Since​

5.7.0

updateNotificationPreferences()​

updateNotificationPreferences(params): Promise<UpdateNotificationPreferencesResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5396

Update notification preferences for the authenticated user.

Partial update - only provided fields are modified, others remain unchanged.

Authentication: Requires JWT auth (call sdk.login() first).

Parameters​

params​

UpdateNotificationPreferencesParams

Preference fields to update

Returns​

Promise<UpdateNotificationPreferencesResult>

Updated notification preferences

Example​

// Disable chat notifications only
const { preferences } = await sdk.updateNotificationPreferences({
  chatEnabled: false,
});
console.log('Chat now:', preferences.chatEnabled); // false

Overseer​

claimOverseerInvite()​

claimOverseerInvite(inviteCode): Promise<{ invite: OverseerInviteWithUrl; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4238

Claim an overseer invite.

The authenticated user's wallet becomes an overseer with global access to ALL tokens on the platform.

Requires JWT authentication.

Parameters​

inviteCode​

string

The invite code from the magic link URL

Returns​

Promise<{ invite: OverseerInviteWithUrl; }>

The claimed invite data

Throws​

ValidationError if invite code is invalid or invite already claimed/revoked/expired

Throws​

ConfigurationError if JWT is not configured

Since​

5.9.0

Example​

Claim an invite

const result = await sdk.claimOverseerInvite('abc123def456...');
console.log('Now an overseer! Status:', result.invite.status);

createOverseerDirect()​

createOverseerDirect(options): Promise<{ overseer: Overseer; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4319

Create an overseer directly (bypassing invite flow).

This directly promotes a user to overseer status without requiring them to claim an invite. A synthetic invite record is created for audit trail.

Use this when you need to promote someone programmatically without requiring their interaction (e.g., CLI admin tools, automated tests).

Requires Admin API key OR JWT as existing Overseer.

Parameters​

options​

CreateOverseerDirectOptions

The options for creating the overseer

Returns​

Promise<{ overseer: Overseer; }>

The created overseer record

Throws​

ValidationError if address format is invalid

Throws​

ConfigurationError if neither auth method is available

Throws​

Error if user is already an overseer (400)

Since​

8.3.0

Example​

Promote a user to overseer

const result = await sdk.createOverseerDirect({
  userAddress: 'eth|1234567890abcdef1234567890abcdef12345678',
  description: 'Platform team - John'
});
console.log('Overseer created:', result.overseer.userAddress);

createOverseerInvite()​

createOverseerInvite(options?): Promise<{ invite: OverseerInviteWithUrl; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4164

Create an overseer invite.

Overseers have global platform access with MANAGER-level permissions across ALL tokens (current and future). This is different from moderators who have token-scoped access.

Requires Admin API key OR JWT as existing Overseer.

Parameters​

options?​

CreateOverseerInviteOptions

Optional description and expiration settings

Returns​

Promise<{ invite: OverseerInviteWithUrl; }>

Created invite data including the invite URL

Throws​

ConfigurationError if neither auth method is available

Throws​

ValidationError if parameters are invalid

Since​

5.9.0

Examples​

Create an invite with description

const result = await sdk.createOverseerInvite({
  description: 'John - Platform Support Team',
});
console.log('Share this link:', result.invite.inviteUrl);

Create invite with expiration

const result = await sdk.createOverseerInvite({
  description: 'Temporary access',
  expiresAt: '2025-12-31T23:59:59Z',
});

getBanStats()​

getBanStats(): Promise<BanStatsResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4402

Get ban stats for the overseer banned users tab

Returns​

Promise<BanStatsResponse>

Ban counts

Since​

8.x.0

getFlagStats()​

getFlagStats(): Promise<FlagStatsResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4426

Get flag stats for the content flags tab

Returns​

Promise<FlagStatsResponse>

Flag counts by status

Since​

8.x.0

getInviteStats()​

getInviteStats(): Promise<InviteStatsResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4418

Get invite stats for the overseer invites tab

Returns​

Promise<InviteStatsResponse>

Invite counts by status

Since​

8.x.0

getMyOverseerStatus()​

getMyOverseerStatus(): Promise<OverseerStatusResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4369

Check own overseer status.

Returns whether the authenticated user is currently an active overseer and their details if so.

Requires JWT authentication.

Returns​

Promise<OverseerStatusResponse>

Overseer status including details if active

Throws​

ConfigurationError if JWT is not configured

Since​

5.9.0

Example​

Check your overseer status

const status = await sdk.getMyOverseerStatus();
if (status.isOverseer) {
  console.log('You are an overseer!');
  console.log('Access granted:', status.overseer?.createdAt);
} else {
  console.log('You are not an overseer');
}

getOverseerInviteByCode()​

getOverseerInviteByCode(inviteCode): Promise<PublicOverseerInviteInfo>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4215

Get overseer invite details by code.

This is a public endpoint used by the frontend claim page to display invite information before the user logs in to claim.

Parameters​

inviteCode​

string

The invite code from the magic link URL

Returns​

Promise<PublicOverseerInviteInfo>

Public invite information (description, status, inviter info)

Throws​

ValidationError if invite code format is invalid

Throws​

Error if invite not found (404)

Since​

5.9.0

Example​

Get invite info before claiming

const info = await sdk.getOverseerInviteByCode('abc123def456...');
console.log(`Invited by: ${info.invitedBy.fullName || info.invitedBy.address}`);
console.log(`Status: ${info.status}`);

getOverseerSummary()​

getOverseerSummary(): Promise<OverseerSummaryResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4394

Get platform summary for CCTV dashboard.

Returns quick counts for the overseer monitoring dashboard:

  • Active streams (pools with live streams)
  • Total viewers across all active streams
  • Pending content flags awaiting review
  • Total pools on the platform

Returns​

Promise<OverseerSummaryResponse>

Platform summary with counts

Throws​

ConfigurationError if neither auth method is available

Since​

5.10.0

Example​

Get platform summary

const summary = await sdk.getOverseerSummary();
console.log(`Active streams: ${summary.activeStreams}`);
console.log(`Total viewers: ${summary.totalViewers}`);
console.log(`Pending flags: ${summary.pendingFlags}`);
console.log(`Total pools: ${summary.totalPools}`);

getOverseerUserSummary()​

getOverseerUserSummary(address): Promise<UserSummaryResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4494

Get comprehensive user summary (Admin/Overseer only - v6.x.0+)

Retrieves full profile, activity metrics, and ban status for a specific user. Useful for overseer dashboard user detail pages.

Requires either Admin API key or JWT with overseer status.

Parameters​

address​

string

User wallet address

Returns​

Promise<UserSummaryResponse>

User profile with detailed activity metrics and ban status

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Throws​

ValidationError if address format is invalid

Since​

6.x.0

Example​

Get user summary

const summary = await sdk.getOverseerUserSummary('eth|abc123...');
console.log(`User: ${summary.profile?.fullName}`);
console.log(`Flags: ${summary.stats.flagsReceived}`);
console.log(`Global ban: ${summary.stats.globalBan}`);

getTokenBanStats()​

getTokenBanStats(): Promise<TokenBanStatsResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4410

Get token ban stats for the overseer delisted tokens tab

Returns​

Promise<TokenBanStatsResponse>

Token ban counts

Since​

8.x.0

getUserStats()​

getUserStats(): Promise<UserStatsResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4434

Get user stats for the overseer users management tab

Returns​

Promise<UserStatsResponse>

User counts (total, flagged, banned)

Since​

8.x.0

listOverseerInvites()​

listOverseerInvites(options?): Promise<PaginatedOverseerInvites>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4193

List all overseer invites.

Requires Admin API key OR JWT as existing Overseer.

Parameters​

options?​

ListOverseerInvitesOptions

Optional filter and pagination options

Returns​

Promise<PaginatedOverseerInvites>

Paginated list of invites

Throws​

ConfigurationError if neither auth method is available

Since​

5.9.0

Examples​

List all invites

const result = await sdk.listOverseerInvites();
console.log(`Total invites: ${result.pageInfo.totalCount}`);

Filter by status with pagination

const result = await sdk.listOverseerInvites({
  status: 'PENDING',
  pageSize: 10,
});

listOverseers()​

listOverseers(options?): Promise<PaginatedOverseers>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4289

List all overseers.

Requires Admin API key OR JWT as existing Overseer.

Parameters​

options?​

ListOverseersOptions

Optional filter and pagination options

Returns​

Promise<PaginatedOverseers>

Paginated list of overseers

Throws​

ConfigurationError if neither auth method is available

Since​

5.9.0

Examples​

List all overseers

const result = await sdk.listOverseers();
console.log(`Total overseers: ${result.pageInfo.totalCount}`);

Filter by status

const active = await sdk.listOverseers({
  status: 'ACTIVE',
});

listOverseerUsers()​

listOverseerUsers(options?): Promise<UsersListResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4469

List users with activity metrics (Admin/Overseer only - v6.x.0+)

Lists all platform users with their activity metrics including comments posted, messages sent, trades, and trading volume.

Requires either Admin API key or JWT with overseer status.

Parameters​

options?​

ListUsersOptions

List options including search, sorting, and pagination

Returns​

Promise<UsersListResponse>

Paginated list of users with activity metrics

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Throws​

ValidationError if options are invalid

Since​

6.x.0

Examples​

List users with pagination

const result = await sdk.listOverseerUsers({ pageSize: 20 });
result.items.forEach(user => {
  console.log(`${user.fullName}: ${user.flagsReceived} flags`);
});

Search and sort

const result = await sdk.listOverseerUsers({
  search: 'alice',
  sortBy: 'activity',
  sortOrder: 'desc',
  pageSize: 10
});

revokeOverseer()​

revokeOverseer(address): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4343

Revoke an overseer's access.

This revokes the overseer's global platform access.

Requires Admin API key OR JWT as existing Overseer.

Parameters​

address​

string

The wallet address of the overseer to revoke

Returns​

Promise<void>

Throws​

ValidationError if address format is invalid

Throws​

ConfigurationError if neither auth method is available

Throws​

Error if overseer not found (404)

Since​

5.9.0

Example​

Revoke an overseer

await sdk.revokeOverseer('eth|1234567890abcdef...');
console.log('Overseer access revoked');

revokeOverseerInvite()​

revokeOverseerInvite(inviteId): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4263

Revoke an overseer invite.

This revokes the invite, preventing it from being claimed. If the invite was already claimed, the overseer loses access.

Requires Admin API key OR JWT as existing Overseer.

Parameters​

inviteId​

number

The ID of the invite to revoke

Returns​

Promise<void>

Throws​

ValidationError if invite ID is invalid

Throws​

ConfigurationError if neither auth method is available

Throws​

Error if invite not found (404)

Since​

5.9.0

Example​

Revoke an invite

await sdk.revokeOverseerInvite(123);
console.log('Invite revoked');

PlatformStats​

getPlatformStats()​

getPlatformStats(): Promise<GetPlatformStatsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5269

Get platform-wide statistics.

Returns aggregated platform metrics including:

  • GALA trading volume over 1h, 24h, 7d
  • Total number of tokens on the platform

Caching: Backend caches stats for 3 minutes.

Public endpoint - no authentication required.

Returns​

Promise<GetPlatformStatsResult>

Platform statistics

Since​

9.0.0

Example​

Get platform stats

const { stats } = await sdk.getPlatformStats();

// Display volume in millions
console.log(`24h Volume: ${(stats.galaVolume24h / 1_000_000).toFixed(2)}M GALA`);

// Display token count
console.log(`${stats.totalTokens} tokens on platform`);

// Display timestamp
const updated = new Date(stats.timestamp);
console.log(`Last updated: ${updated.toLocaleString()}`);

Pool Information​

fetchAllPools()​

fetchAllPools(options?): Promise<PoolsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:924

Fetch all available pools with automatic pagination

Convenience method that fetches all available pools by automatically handling pagination through cursor-based iteration.

Cache Warming: Maintains the same opportunistic cache warming as fetchPools(), caching immutable token metadata for all returned pools to enable instant local calculations.

Parameters​

options?​

Omit<FetchPoolsOptions, "cursor" | "pageSize">

Optional filters (type, tokenName, search)

Returns​

Promise<PoolsResult>

Promise with all pools

Since​

3.11.0

Examples​

Fetch all recent pools

const all = await sdk.fetchAllPools({ type: 'recent' });
console.log(`Fetched ${all.items.length} total pools`);
console.log(`Total available: ${all.total}`);

Fetch all pools matching search

const dragons = await sdk.fetchAllPools({ search: 'dragon' });
console.log(`Found ${dragons.items.length} dragon tokens`);

Cache warming demonstration

// Fetch all pools - automatically warms cache for all tokens
const all = await sdk.fetchAllPools();

// Check cache statistics
const cacheInfo = sdk.getCacheInfo();
console.log(`Cached ${cacheInfo.totalTokens} tokens from ${all.items.length} pools`);

// All subsequent calculations are instant (no network calls)
const calculations = await Promise.all(
  all.items.slice(0, 10).map(pool =>
    sdk.calculateBuyAmountLocal({
      tokenName: pool.tokenName,
      amount: '100',
      type: 'native',
      currentSupply: '500000'
    })
  )
);
console.log('Calculated 10 prices instantly using cached metadata');

fetchPoolDetailsForCalculation()​

fetchPoolDetailsForCalculation(tokenName): Promise<{ currentSupply: string; maxSupply: string; remainingTokens: string; reverseBondingCurveMaxFeeFactor: number; reverseBondingCurveMinFeeFactor: number; reverseBondingCurveNetFeeFactor: number; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1302

Fetch optimized pool details for local calculations

Retrieves essential pool parameters needed for bonding curve calculations:

  • Current supply (computed with full precision)
  • Reverse bonding curve fee factors (normalized to numbers)
  • Net fee factor (max - min, for convenience)
  • Remaining tokens available in the pool

This method is more efficient than fetchPoolDetails() as it returns only the fields needed for calculations, with automatic normalization applied.

Parameters​

tokenName​

string

Token name to fetch pool details for

Returns​

Promise<{ currentSupply: string; maxSupply: string; remainingTokens: string; reverseBondingCurveMaxFeeFactor: number; reverseBondingCurveMinFeeFactor: number; reverseBondingCurveNetFeeFactor: number; }>

Promise with calculation-optimized pool details

Throws​

If token not found or vault address invalid

Throws​

If GalaChain client not configured

Throws​

If API request fails

Since​

3.8.0

Examples​

Basic usage

const details = await sdk.fetchPoolDetailsForCalculation('mytoken');
console.log('Current supply:', details.currentSupply);
console.log('Remaining tokens:', details.remainingTokens);
console.log('Max fee factor:', details.reverseBondingCurveMaxFeeFactor);
console.log('Min fee factor:', details.reverseBondingCurveMinFeeFactor);
console.log('Net fee factor:', details.reverseBondingCurveNetFeeFactor);

Use with local calculations

// Fetch pool details once
const details = await sdk.fetchPoolDetailsForCalculation('mytoken');

// Use in multiple local calculations without additional API calls
const buyCalc = await sdk.calculateBuyAmountLocal({
  tokenName: 'mytoken',
  amount: '100',
  type: 'native',
  currentSupply: details.currentSupply
});

const sellCalc = await sdk.calculateSellAmountLocal({
  tokenName: 'mytoken',
  amount: '50',
  type: 'exact',
  currentSupply: details.currentSupply,
  reverseBondingCurveMaxFeeFactor: details.reverseBondingCurveMaxFeeFactor,
  reverseBondingCurveMinFeeFactor: details.reverseBondingCurveMinFeeFactor
});

Check graduation status

const details = await sdk.fetchPoolDetailsForCalculation('mytoken');
console.log(`Tokens available: ${details.remainingTokens}`);

if (parseFloat(details.remainingTokens) === 0) {
  console.log('Pool is graduated!');
} else {
  console.log(`Need to buy ${details.remainingTokens} more tokens to graduate`);
}

fetchPools()​

fetchPools(options?): Promise<PoolsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:873

Fetch pools with optional filters

Automatically warms the token metadata cache with RBC fees and vault addresses from the pools response for optimal performance in local calculations.

Cache Warming: This method opportunistically caches immutable token metadata (reverse bonding curve fees, vault addresses) for every pool returned. This enables instant local calculations without additional API calls.

Options are those GET /v1/tokens accepts: type RECENT / POPULAR / RECORDINGS / SECONDS_STREAMED and streamStatus IDLE / ACTIVE / DISABLED (any case), pageSize 1 to 100 (default 10); anything else is a ValidationError before a request is made.

Parameters​

options?​

FetchPoolsOptions

Optional filters for pool fetching

Returns​

Promise<PoolsResult>

Promise with pagination metadata

Since​

1.0.0

Examples​

Basic pool fetching

const result = await sdk.fetchPools({ type: 'RECENT', pageSize: 20 });
console.log(`Fetched ${result.items.length} pools`);
console.log(`Total pools: ${result.total}`);

Cache warming demonstration

// Before fetching - cache is empty
let cacheInfo = sdk.getCacheInfo();
console.log('Cached tokens:', cacheInfo.totalTokens); // 0

// Fetch pools - automatically warms cache
await sdk.fetchPools({ pageSize: 20 });

// After fetching - cache is warmed
cacheInfo = sdk.getCacheInfo();
console.log('Cached tokens:', cacheInfo.totalTokens); // 20

// Now local calculations are instant (no network calls)
const calc = await sdk.calculateBuyAmountLocal({
  tokenName: 'mytoken',
  amount: '100',
  type: 'native',
  currentSupply: '500000'
});
console.log('Instant result:', calc.amount); // <1ms, used cached RBC fees

Performance optimization with cache

// Warm cache once
await sdk.fetchPools({ type: 'popular', pageSize: 50 });

// All subsequent calculations for these tokens are instant
const tokens = ['token1', 'token2', 'token3'];
const calculations = await Promise.all(
  tokens.map(token =>
    sdk.calculateBuyAmountLocal({
      tokenName: token,
      amount: '1000',
      type: 'exact',
      currentSupply: '1000000'
    })
  )
);
// All 3 calculations complete in <5ms total (no network calls)

isTokenGraduated()​

isTokenGraduated(tokenName): Promise<boolean>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1350

Check if a token pool is graduated

Convenience method that fetches pool details and returns just the graduation status. A token is considered graduated when all tokens in the bonding curve pool have been purchased, transitioning the token to full DEX trading.

This method checks the pool's saleStatus field - pools with status 'Completed' are considered graduated.

Parameters​

tokenName​

string

Token name to check graduation status for

Returns​

Promise<boolean>

Promise True if the token pool has graduated, false if still in bonding curve phase

Throws​

ValidationError if token not found or vault address invalid

Throws​

ConfigurationError if GalaChain client not configured

Throws​

NetworkError if API request fails

Since​

3.8.0

Examples​

Check if a token has graduated

const isGraduated = await sdk.isTokenGraduated('anime');
if (isGraduated) {
  console.log('Token has graduated to DEX trading!');
} else {
  console.log('Token is still in bonding curve phase');
}

Use in conditional logic

const graduated = await sdk.isTokenGraduated('mytoken');
if (graduated) {
  // Use DEX API for graduated token
  await sdk.swapOnDex(...);
} else {
  // Use bonding curve for non-graduated token
  await sdk.buy(...);
}

Pools​

getPoolRealtimeState()​

getPoolRealtimeState(tokenName): Promise<{ chatConfig: TokenConfigData | null; chatConfigError?: string; holderCount: { count: number; totalBalance: string; } | null; holderCountError?: string; price: TokenSpotPrice | null; priceError?: string; recentTrades: TradesQueryResult | null; recentTradesError?: string; tokenName: string; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6218

Get a combined real-time snapshot of a pool: holder count, chat/comments config, recent trades, and current price - fetched in parallel from their real underlying endpoints.

There is no single backend endpoint for this; each field comes from a separate real fetch. A field that fails independently is reported as null with its error message rather than failing the whole call - a temporary price-feed hiccup should not hide an otherwise-successful holder count and trade history.

There is no platform data for "stream status" (ACTIVE/IDLE/DISABLED) as a standalone concept separate from the chat config, and no "active moderators" summary beyond getActiveModerators() - this returns only fields with a real, single-token data source.

Parameters​

tokenName​

string

Token to fetch a snapshot for

Returns​

Promise<{ chatConfig: TokenConfigData | null; chatConfigError?: string; holderCount: { count: number; totalBalance: string; } | null; holderCountError?: string; price: TokenSpotPrice | null; priceError?: string; recentTrades: TradesQueryResult | null; recentTradesError?: string; tokenName: string; }>

Combined snapshot; any field that failed to fetch is null with an error message

Since​

7.1.0

getTokenConfig()​

getTokenConfig(tokenName): Promise<TokenConfigData>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6126

Get the current token configuration, including chat/comments enabled status.

Reads the same record updateTokenConfig() writes - there is no dedicated chat-status endpoint. Chat status is included in the token's general config record.

Parameters​

tokenName​

string

Token name to fetch configuration for

Returns​

Promise<TokenConfigData>

The token's current configuration

Since​

7.1.0

updateTokenConfig()​

updateTokenConfig(tokenName, config): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6113

Update token configuration (chat/comments enabled status).

Requires JWT authentication with owner or admin role.

Parameters​

tokenName​

string

Token name to configure

config​

UpdateTokenConfigOptions

Configuration options

Returns​

Promise<void>

Promise

Throws​

ValidationError if options are invalid

Throws​

ConfigurationError if JWT is not configured

Since​

7.0.0

Examples​

Disable chat for a token

await sdk.updateTokenConfig('anime', { chatEnabled: false });

Enable comments for a token

await sdk.updateTokenConfig('anime', { commentsEnabled: true });

Update messaging and comments

await sdk.updateTokenConfig('anime', {
  chatEnabled: true,
  commentsEnabled: false
});

Update social links

await sdk.updateTokenConfig('anime', {
  websiteUrl: 'https://anime.example.com',
  twitterUrl: 'https://twitter.com/animeproject',
  telegramUrl: 'https://t.me/animegroup',
  discordUrl: 'https://discord.gg/anime'
});

Update streaming configuration

await sdk.updateTokenConfig('anime', {
  streamingEnabled: true,
  streamLanguage: 'en',
  nextLiveStreamAt: '2026-02-01T18:00:00Z'
});

Real-time Monitoring​

subscribeToTokenCreations()​

subscribeToTokenCreations(callback, options?): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9146

Subscribe to real-time token creation broadcasts

Listens to WebSocket broadcasts for ALL token creations globally. Provides real-time notifications with ~1-2 second latency (vs 15-30s polling).

Architecture: The backend broadcasts transaction confirmation events to ALL connected Socket.IO clients. This listener captures "CreateSale" events which indicate token creation.

Key Difference from onLaunchpadTokenCreation():

  • subscribeToTokenCreations() - WebSocket broadcasts (instant, <2s latency)
  • onLaunchpadTokenCreation() - REST API polling (slow, 15-30s latency)

Connection Management:

  • If WebSocket is already connected, listener is registered immediately
  • If not connected, automatically initiates connection with 3-second timeout
  • Connection failures are logged and can be handled via error callback

Cleanup Function:

  • Safe to call multiple times (idempotent)
  • Removes listener and cleans up tracking state
  • Returns immediately if listener was never registered

Parameters​

callback​

(token) => void

Called when any token is created

options?​

Optional filtering and error handling

creatorFilter?​

string

Only receive tokens from specific creator address

onError?​

(error) => void

Called if WebSocket connection fails

Returns​

Cleanup function to stop listening - safe to call multiple times

() => void

Since​

4.1.0

Throws​

Error if WebSocket service not initialized

Examples​

Basic usage - listen to all token creations

const cleanup = sdk.subscribeToTokenCreations((token) => {
  console.log(`Token created: ${token.tokenName} by ${token.creatorAddress}`);
});

// Stop listening when done
cleanup();

Filter to specific creator

const cleanup = sdk.subscribeToTokenCreations(
  (token) => console.log(`My token: ${token.tokenName}`),
  {
    creatorFilter: sdk.getAddress(),
    onError: (error) => console.error('Connection failed:', error)
  }
);

Monitor for competitor tokens with error handling

const cleanup = sdk.subscribeToTokenCreations(
  (token) => {
    console.log(`New token: ${token.tokenName} - ${token.symbol}`);
    // Could trigger automatic buy/analysis
  },
  {
    onError: (error) => {
      console.error('Real-time monitoring failed:', error);
      // Fallback to polling
    }
  }
);

Resource Management​

cleanup()​

cleanup(): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9273

Cleanup SDK resources and connections

Releases WebSocket references and performs cleanup of SDK resources. Should be called when the SDK instance is no longer needed to prevent memory leaks and ensure proper resource management.

Returns​

Promise<void>

Since​

2.1.0

Examples​

Basic cleanup

const sdk = new LaunchpadSDK({ wallet });

// Use SDK for operations...
await sdk.launchToken({...});

// Cleanup when done
await sdk.cleanup();

Cleanup in application shutdown

process.on('SIGINT', async () => {
  console.log('Shutting down...');
  await sdk.cleanup();
  process.exit(0);
});

cleanupAll()​

static cleanupAll(debug?): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9299

Cleanup all SDK instances and shared resources

Forces cleanup of all shared WebSocket connections and resources across all SDK instances. Use this for application-wide cleanup or testing teardown.

Parameters​

debug?​

boolean

Enable debug logging

Returns​

void

Since​

2.1.0

Examples​

Application shutdown

// Cleanup all SDK instances and shared resources
LaunchpadSDK.cleanupAll(true);

Test cleanup

afterEach(() => {
  // Ensure clean state between tests
  LaunchpadSDK.cleanupAll();
});

Streaming​

addSimulcastTarget()​

addSimulcastTarget(options): Promise<AddSimulcastTargetResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2975

Add a simulcast target to a stream.

Configure the stream to rebroadcast to an external platform.

Parameters​

options​

AddSimulcastTargetOptions

Simulcast target configuration

Returns​

Promise<AddSimulcastTargetResult>

Promise resolving to the new target

Throws​

Error if wallet is not configured

Since​

5.1.0

Example​

Add YouTube simulcast

const { target } = await sdk.addSimulcastTarget({
  tokenName: 'mytoken',
  platform: 'youtube',
  streamKey: 'xxxx-xxxx-xxxx-xxxx',
  url: 'rtmp://a.rtmp.youtube.com/live2',
});
console.log(`Added target: ${target.id}`);

deleteRecording()​

deleteRecording(tokenName, assetId): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2930

Delete a recording.

Permanently removes a recording. This action cannot be undone.

Parameters​

tokenName​

string

Token name (lowercase)

assetId​

string

Recording asset ID

Returns​

Promise<void>

Promise resolving when deleted

Throws​

Error if wallet is not configured

Since​

5.1.0

disableStream()​

disableStream(tokenName): Promise<{ enabled: boolean; tokenName: string; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2812

Disable streaming for a specific token (Admin only).

Prevents new streams from being started for this token. Existing active streams will continue until they end.

Parameters​

tokenName​

string

Token name (lowercase)

Returns​

Promise<{ enabled: boolean; tokenName: string; }>

Promise resolving when disabled

Throws​

Error if admin API key is not configured

Since​

5.1.0

Admin​

Requires streamAdminApiKey configuration

enableStream()​

enableStream(tokenName): Promise<{ enabled: boolean; tokenName: string; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2829

Enable streaming for a specific token (Admin only).

Re-enables streaming capability for a previously disabled token.

Parameters​

tokenName​

string

Token name (lowercase)

Returns​

Promise<{ enabled: boolean; tokenName: string; }>

Promise resolving when enabled

Throws​

Error if admin API key is not configured

Since​

5.1.0

Admin​

Requires streamAdminApiKey configuration

getAvailableRoles()​

getAvailableRoles(): Promise<AvailableRolesResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3117

Get all available roles and permissions for token delegation.

Returns reference data about the role system, including:

  • All available roles (OWNER, MANAGER, TECHNICAL_PRODUCER, MODERATOR)
  • Role descriptions and hierarchy levels
  • Permissions assigned to each role
  • Complete list of all available permissions

This is static reference data - it doesn't change per user or token.

Returns​

Promise<AvailableRolesResponse>

Promise resolving to available roles and permissions

Since​

5.10.0

Example​

Get available roles

const { roles, permissions } = await sdk.getAvailableRoles();

// List all roles
roles.forEach(role => {
  console.log(`${role.name} (level ${role.level}): ${role.description}`);
  console.log('  Permissions:', role.permissions.join(', '));
});

// Build a role selector dropdown
const roleOptions = roles.map(role => ({
  value: role.name,
  label: role.description,
  level: role.level,
}));

getGlobalStreamingStatus()​

getGlobalStreamingStatus(): Promise<GlobalStreamingStatus>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3008

Get global streaming status.

Returns platform-wide streaming status including maintenance windows.

Returns​

Promise<GlobalStreamingStatus>

Promise resolving to global streaming status

Since​

5.1.0

Example​

Check if streaming is available

const status = await sdk.getGlobalStreamingStatus();
if (!status.enabled) {
  console.log(`Streaming disabled: ${status.reason ?? 'maintenance'}`);
}

getRecordingDownload()​

getRecordingDownload(tokenName, assetId): Promise<RecordingDownloadResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2916

Get download URL for a recording.

Returns a signed URL for downloading a specific recording. URLs are typically valid for a limited time.

Parameters​

tokenName​

string

Token name (lowercase)

assetId​

string

Recording asset ID

Returns​

Promise<RecordingDownloadResult>

Promise resolving to download URL

Throws​

Error if wallet is not configured

Since​

5.1.0

Example​

Download a recording

const result = await sdk.getRecordingDownload('mytoken', 'asset-123');
console.log(`Download: ${result.downloadUrl}`);
console.log(`Expires: ${result.expiresAt}`);

getSimulcastTargets()​

getSimulcastTargets(tokenName): Promise<SimulcastTargetsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2950

Get simulcast targets for a stream.

Returns list of configured simulcast destinations (YouTube, Twitch, etc.).

Parameters​

tokenName​

string

Token name (lowercase)

Returns​

Promise<SimulcastTargetsResult>

Promise resolving to simulcast targets

Since​

5.1.0

Example​

Check simulcast configuration

const { targets } = await sdk.getSimulcastTargets('mytoken');
targets.forEach(t => {
  console.log(`${t.passthrough ?? t.url}: ${t.status}`);
});

getStreamCredentials()​

getStreamCredentials(tokenName): Promise<StreamCredentials>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2873

Get stream credentials (key and URL).

Returns the current stream key and RTMP URL for streaming.

Parameters​

tokenName​

string

Token name (lowercase)

Returns​

Promise<StreamCredentials>

Promise resolving to stream credentials

Since​

6.13.0

Example​

Get stream credentials

const creds = await sdk.getStreamCredentials('mytoken');
console.log(`Stream Key: ${creds.streamKey}`);
console.log(`RTMPS URL: ${creds.rtmpsUrl}`);
console.log(`Playback ID: ${creds.playbackId}`);

getStreamRecordings()​

getStreamRecordings(options): Promise<RecordingsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2894

Get recordings for a stream.

Returns list of available recordings from past streams.

Parameters​

options​

FetchRecordingsOptions

Pagination options

Returns​

Promise<RecordingsResult>

Promise resolving to recordings list

Since​

5.1.0

Example​

List recordings

const { recordings, total } = await sdk.getStreamRecordings({ tokenName: 'mytoken' });
recordings.forEach(rec => {
  console.log(`${rec.createdAt}: ${rec.duration}s - ${rec.status}`);
});

getStreamRole()​

getStreamRole(options): Promise<StreamRoleResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3082

Get the authenticated user's role for a token's stream.

Returns the user's effective role based on:

  • Token ownership (OWNER role)
  • Claimed moderator invite (MANAGER, TECHNICAL_PRODUCER, or MODERATOR)
  • No access (null role)

This enables the frontend Studio page to detect permissions and show the appropriate UI based on the user's role.

Authentication: Optional JWT - returns null role if not authenticated.

Parameters​

options​

GetStreamRoleOptions

GetStreamRoleOptions with tokenName

Returns​

Promise<StreamRoleResponse>

Promise resolving to StreamRoleResponse with role, isOwner flag, source, and inviteScope

Since​

5.7.0

Example​

Check stream access

const roleInfo = await sdk.getStreamRole({ tokenName: 'mytoken' });

if (roleInfo.role === null) {
  console.log('No access to this stream');
} else if (roleInfo.isOwner) {
  console.log('You are the token owner');
} else {
  console.log(`You have ${roleInfo.role} access via ${roleInfo.source}`);
}

// Use role for permission checks
const canStream = ['OWNER', 'MANAGER', 'TECHNICAL_PRODUCER'].includes(roleInfo.role ?? '');
const canModerate = ['OWNER', 'MANAGER', 'MODERATOR'].includes(roleInfo.role ?? '');

getTokenAccess()​

getTokenAccess(options): Promise<TokenAccessResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3155

Check if the authenticated user has Studio access for a token.

Returns comprehensive access information combining:

  • Token ownership check (OWNER role)
  • Claimed moderator invite (MANAGER, TECHNICAL_PRODUCER, MODERATOR)
  • Platform overseer status (global access)

This is used by the frontend to determine whether to show the "Click to Studio" link on the buy-sell page.

Parameters​

options​

GetTokenAccessOptions

Options with tokenName

Returns​

Promise<TokenAccessResult>

Promise resolving to access info with role, permissions, and flags

Since​

5.11.0

Example​

Check Studio access

const access = await sdk.getTokenAccess({ tokenName: 'mytoken' });

if (!access.hasAccess) {
  console.log('No Studio access for this token');
} else {
  console.log(`Access via: ${access.accessSource}`);
  console.log(`Role: ${access.role}`);
  console.log('Permissions:', access.permissions);

  if (access.permissions.canStream) {
    console.log('User can start/stop streams');
  }
  if (access.permissions.canModerate) {
    console.log('User can moderate chat');
  }
}

removeSimulcastTarget()​

removeSimulcastTarget(tokenName, targetId): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2989

Remove a simulcast target from a stream.

Stops rebroadcasting to the specified platform.

Parameters​

tokenName​

string

Token name (lowercase)

targetId​

string

Simulcast target ID

Returns​

Promise<void>

Promise resolving when removed

Throws​

Error if wallet is not configured

Since​

5.1.0

resetStreamKey()​

resetStreamKey(tokenName): Promise<ResetStreamKeyResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2853

Reset the stream key for a token.

Generates a new stream key, invalidating the previous one. Use this if the stream key has been compromised.

Parameters​

tokenName​

string

Token name (lowercase)

Returns​

Promise<ResetStreamKeyResult>

Promise resolving to new stream credentials

Throws​

Error if wallet is not configured

Since​

5.1.0

Example​

Reset compromised stream key

const newCreds = await sdk.resetStreamKey('mytoken');
console.log(`New Stream Key: ${newCreds.streamKey}`);
console.log(`Reset at: ${newCreds.resetAt}`);

setGlobalStreamingEnabled()​

setGlobalStreamingEnabled(enabled): Promise<GlobalStreamingStatus>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3045

Enable or disable streaming globally (Admin only).

Controls platform-wide streaming capability.

Parameters​

enabled​

boolean

Whether streaming should be enabled

Returns​

Promise<GlobalStreamingStatus>

Promise resolving when updated

Throws​

Error if admin API key is not configured

Since​

5.1.0

Admin​

Requires streamAdminApiKey configuration

setNextLiveStreamCountdown()​

setNextLiveStreamCountdown(tokenName, nextLiveStreamAt): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:3031

Set the next live stream countdown time (v6.x.0+)

Convenience method that sets a scheduled time for the next live stream. The frontend can display a countdown timer based on this time.

Parameters​

tokenName​

string

Token name (lowercase)

nextLiveStreamAt​

string | Date | null

Scheduled stream time (ISO 8601 string, Date, or null to clear)

Returns​

Promise<void>

Throws​

If token name or date is invalid

Since​

6.x.0

Example​

Set countdown

await sdk.setNextLiveStreamCountdown('mytoken', '2025-01-15T18:00:00Z');
// or
await sdk.setNextLiveStreamCountdown('mytoken', new Date('2025-01-15T18:00:00Z'));
// Clear countdown
await sdk.setNextLiveStreamCountdown('mytoken', null);

startStream()​

startStream(tokenName): Promise<StartStreamResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2770

Start a live stream for a token.

Creates a new stream session and returns streaming credentials. The stream key can be used with OBS or other RTMP-compatible software.

Parameters​

tokenName​

string

Token name (lowercase)

Returns​

Promise<StartStreamResult>

Promise resolving to stream credentials

Throws​

Error if wallet is not configured

Throws​

Error if streaming is disabled for this token

Since​

5.1.0

Example​

Start streaming for a token

const stream = await sdk.startStream('mytoken');
console.log(`RTMP URL: ${stream.rtmpUrl}`);
console.log(`Stream Key: ${stream.streamKey}`);
console.log(`Playback URL: ${stream.playbackUrl}`);

stopStream()​

stopStream(tokenName): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2797

Stop an active stream for a token.

Immediately ends the current broadcast and sets the stream to IDLE. Requires JWT authentication (stream creator only). The stream can be restarted by calling startStream() again.

Unlike disableStream() which is an admin operation that prevents streaming, stopStream() is for stream owners to end their current broadcast.

Parameters​

tokenName​

string

Token name (lowercase)

Returns​

Promise<void>

Throws​

ValidationError if token name is invalid

Throws​

Error if user is not authorized (not stream owner)

Throws​

Error if stream is not currently active

Since​

5.3.0

See​

https://www.mux.com/docs/api-reference/video/live-streams/signal-live-stream-complete

Example​

Stop an active stream

await sdk.stopStream('mytoken');
console.log('Stream stopped successfully');

Token Creation​

launchToken()​

launchToken(data): Promise<TokenLaunchResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7975

Launch a new token with bonding curve trading

Creates a new launchpad token with an automated bonding curve for initial price discovery and liquidity. This method handles the complete token creation workflow including blockchain submission, WebSocket monitoring, and confirmation waiting. Returns comprehensive launch details after on-chain confirmation.

Process Flow:

  1. Validates token data (name uniqueness, symbol format, etc.)
  2. Submits launch transaction to GalaChain
  3. Monitors transaction via WebSocket for real-time updates
  4. Waits for blockchain confirmation
  5. Returns complete token metadata including vault address

Important: This is a write operation requiring wallet configuration.

Parameters​

data​

LaunchTokenData

Token launch configuration

Returns​

Promise<TokenLaunchResult>

Promise with complete token launch result including vault address, transaction ID, and metadata

Throws​

If wallet not configured or token data invalid

Throws​

If transaction monitoring fails

Throws​

If blockchain transaction fails

Throws​

If API request fails

Since​

4.0.4-beta.0

Examples​

Basic token launch

import { Wallet } from 'ethers';
import { LaunchpadSDK } from '@gala-chain/launchpad-sdk';

const wallet = new Wallet(process.env.PRIVATE_KEY);
const sdk = new LaunchpadSDK({ wallet });

const result = await sdk.launchToken({
  tokenName: 'mytoken',
  tokenSymbol: 'MTK',
  tokenDescription: 'My amazing token for the community',
  tokenImage: 'https://example.com/token.png'
});

console.log('Token launched successfully!');
console.log('Token:', result.tokenName);
console.log('Symbol:', result.tokenSymbol);
console.log('Vault:', result.vaultAddress);
console.log('Transaction:', result.transactionId);
console.log('Creator:', result.creatorAddress);

Launch with pre-buy and custom supply

const result = await sdk.launchToken({
  tokenName: 'premium',
  tokenSymbol: 'PREM',
  tokenDescription: 'Premium features token',
  tokenImage: 'https://example.com/premium.png',
  preBuyQuantity: '1000', // Buy 1000 tokens immediately
  maxSupply: '5000000' // Custom max supply of 5 million
});

console.log(`Pre-bought ${result.preBuyQuantity} tokens`);

Launch with custom bonding curve fees

const result = await sdk.launchToken({
  tokenName: 'custom',
  tokenSymbol: 'CSTM',
  tokenDescription: 'Custom fee structure',
  bondingCurveFees: {
    minFeePortion: '0.15', // 15% minimum fee
    maxFeePortion: '0.45'  // 45% maximum fee
  }
});

Error handling

try {
  const result = await sdk.launchToken({
    tokenName: 'newtoken',
    tokenSymbol: 'NEW',
    tokenDescription: 'New project token'
  });
  console.log('Success!', result.transactionId);
} catch (error) {
  if (error.code === 'WALLET_REQUIRED') {
    console.error('Please configure wallet before launching token');
  } else if (error.code === 'TOKEN_NAME_TAKEN') {
    console.error('Token name already exists, choose another');
  } else if (error.code === 'TRANSACTION_FAILED') {
    console.error('Blockchain transaction failed:', error.message);
  } else {
    console.error('Launch failed:', error);
  }
}

Token Data​

fetchTokenClassesWithSupply()​

fetchTokenClassesWithSupply(tokenClasses): Promise<GalaChainTokenClass[]>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1226

Fetch supply information for token classes from GalaChain

Queries GalaChain for authoritative token supply data including:

  • Total supply and maximum supply
  • Total burned amount
  • Mint-related supply metrics
  • Token metadata (symbol, decimals, name)

Parameters​

tokenClasses​

GalaChainTokenClassKey[]

Array of token class keys to query

Returns​

Promise<GalaChainTokenClass[]>

Promise<GalaChainTokenClass[]> Array of token classes with supply information

Throws​

if tokenClasses array is empty

Throws​

if network request fails

Example​

// Query single token
const supplies = await sdk.fetchTokenClassesWithSupply([
  { collection: 'GALA', category: 'Unit', type: 'none', additionalKey: 'none' }
]);
console.log(`GALA total supply: ${supplies[0].totalSupply}`);

// Query multiple tokens
const multiSupplies = await sdk.fetchTokenClassesWithSupply([
  { collection: 'GALA', category: 'Unit', type: 'none', additionalKey: 'none' },
  { collection: 'GUSDC', category: 'Unit', type: 'none', additionalKey: 'eth:0x...' }
]);

// Print supply summary
for (const token of multiSupplies) {
  console.log(`${token.symbol}: ${token.totalSupply} (max: ${token.maxSupply})`);
}

Since​

3.32.0

Token Information​

fetchTokenDistribution()​

fetchTokenDistribution(tokenName): Promise<TokenDistributionResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:957

Fetch token ownership distribution with holder percentages

Retrieves complete token holder distribution data including all wallet addresses, their token balances, and ownership percentages. This endpoint returns ALL holders in a single non-paginated response, making it perfect for distribution analysis, whale tracking, and supply health metrics.

Parameters​

tokenName​

string

Token name to fetch distribution for (e.g., 'anime', 'mytoken')

Returns​

Promise<TokenDistributionResult>

Promise with distribution data including holders array, total supply, and total holder count

Throws​

If tokenName is invalid or empty

Throws​

If API request fails

Since​

4.0.4-beta.0

Examples​

Basic distribution query

const distribution = await sdk.fetchTokenDistribution('anime');
console.log(`Total holders: ${distribution.totalHolders}`);
console.log(`Total supply: ${distribution.totalSupply}`);
distribution.holders.forEach(holder => {
  console.log(`${holder.address}: ${holder.percentage}%`);
});

Whale analysis

const dist = await sdk.fetchTokenDistribution('mytoken');
const whales = dist.holders.filter(h => h.percentage > 5);
console.log(`Found ${whales.length} whales with >5% ownership`);

fetchUserHolderContext()​

fetchUserHolderContext(tokenName, userAddress): Promise<UserHolderContext>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1103

Fetch a user's holder context for a specific token

Retrieves holder tier, quantity, percentage, and creator status for a user on a specific token. Used for user cards in comments/chat to show token-specific holder information.

Parameters​

tokenName​

string

Token name to check holdings for (e.g., 'anime', 'mytoken')

userAddress​

string

User wallet address to lookup

Returns​

Promise<UserHolderContext>

Promise with user holder context including tier, quantity, percentage, isCreator

Throws​

If tokenName or userAddress is invalid or empty

Throws​

If API request fails

Since​

3.7.0

Example​

Get holder context for user card

const context = await sdk.fetchUserHolderContext('anime', '0x1234...');
if (context.holderTier) {
  console.log(`User is a ${context.holderTier.tierName} holding ${context.percentage}%`);
}
if (context.isCreator) {
  console.log('User created this token');
}

getHolderCount()​

getHolderCount(tokenName): Promise<{ count: number; totalBalance: string; }>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:997

Get the total holder count and combined balance for a token

Convenience wrapper around fetchTokenDistribution().

Parameters​

tokenName​

string

Token name (e.g. 'anime')

Returns​

Promise<{ count: number; totalBalance: string; }>

Object with count (number of holders) and totalBalance (total supply across all holders)

Throws​

If tokenName is invalid

Since​

9.2.0

Example​

const { count, totalBalance } = await sdk.getHolderCount('anime');
console.log(`${count} holders, total supply: ${totalBalance}`);

getHolderRank()​

getHolderRank(tokenName, userAddress): Promise<{ balance: string; holderCount: number; rank: number; } | null>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1022

Get a user's holder rank and balance for a token

Returns the user's position in the holder distribution (rank 1 = largest holder), their balance, and the total holder count. Returns null if the user holds no tokens.

Parameters​

tokenName​

string

Token name (e.g. 'anime')

userAddress​

string

User's wallet address (eth|... format)

Returns​

Promise<{ balance: string; holderCount: number; rank: number; } | null>

Rank info or null if user is not a holder

Throws​

If tokenName or userAddress is invalid

Since​

9.2.0

Example​

const rank = await sdk.getHolderRank('anime', 'eth|1234...');
if (rank) {
  console.log(`Rank #${rank.rank} of ${rank.holderCount} holders, balance: ${rank.balance}`);
}

getHoldersByBalance()​

getHoldersByBalance(tokenName, options?): Promise<TokenHolder & object[]>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1049

Get holders within a specific balance range

Convenience wrapper around fetchTokenDistribution() that filters holders by balance and returns them enriched with their rank.

Parameters​

tokenName​

string

Token name (e.g. 'anime')

options?​

Filter options

limit?​

number

Maximum results to return (default: 100, max: 1000)

maxBalance?​

number

Maximum balance (no ceiling if omitted)

minBalance?​

number

Minimum balance (no floor if omitted)

Returns​

Promise<TokenHolder & object[]>

Filtered holders with rank

Throws​

If tokenName is invalid

Since​

9.2.0

Example​

const whales = await sdk.getHoldersByBalance('anime', { minBalance: 10000 });
console.log(`${whales.length} whales hold ≥10,000 tokens`);

getTopHolders()​

getTopHolders(tokenName, limit?): Promise<TokenHolder & object[]>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:977

Get the top N token holders by balance

Convenience wrapper around fetchTokenDistribution() that returns the top holders sorted by balance descending, each enriched with their rank.

Parameters​

tokenName​

string

Token name (e.g. 'anime')

limit?​

number

Number of top holders to return (default: 10, max: 100)

Returns​

Promise<TokenHolder & object[]>

Array of top holders with address, balance, percentage, and rank

Throws​

If tokenName is invalid

Since​

9.2.0

Example​

const topHolders = await sdk.getTopHolders('anime', 5);
topHolders.forEach(h => console.log(`#${h.rank} ${h.address}: ${h.balance} (${h.percentage}%)`));

Token Lookup​

fetchToken()​

fetchToken(tokenName): Promise<PoolData>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8099

Fetch full token pool data by token name Returns complete PoolData including streaming fields

Parameters​

tokenName​

string

The token name to fetch (e.g., 'anime')

Returns​

Promise<PoolData>

The full PoolData object with all fields including streaming data

Throws​

Error if token not found or request fails

Since​

6.0.0

Example​

const pool = await sdk.fetchToken('anime');
console.log(pool.tokenName, pool.playbackId, pool.muxStreamStatus);

fetchTokenStats()​

fetchTokenStats(tokenName): Promise<FetchTokenStatsResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8144

Fetch engagement statistics for a token (v7.1.0+)

Returns metrics for chat activity, comments, and overall engagement on a token. Useful for token detail pages and engagement analytics.

Parameters​

tokenName​

string

Token name to fetch stats for

Returns​

Promise<FetchTokenStatsResult>

Engagement statistics result

Throws​

ValidationError if tokenName is invalid

Since​

7.1.0

Example​

const stats = await sdk.fetchTokenStats('anime');
console.log(`Chat messages: ${stats.data.chatMessageCount}`);
console.log(`Comments: ${stats.data.commentCount}`);

Token Resolution​

resolveVaultAddress()​

resolveVaultAddress(tokenName): Promise<string | null>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8811

Resolve token name to its GalaChain vault address

Performs a lookup to find the blockchain vault address associated with a token name. Vault addresses are used internally for direct GalaChain API calls. This method is useful for caching, optimization, or low-level blockchain operations.

Parameters​

tokenName​

string

Token name to resolve (e.g., 'anime', 'mytoken')

Returns​

Promise<string | null>

Promise resolving to vault address string, or null if token not found

Throws​

If API request fails

Since​

4.0.4-beta.0

Example​

Resolve vault for direct API calls

const vaultAddress = await sdk.resolveVaultAddress('anime');
if (vaultAddress) {
  console.log(`Vault address: ${vaultAddress}`);
  // Use for direct GalaChain API calls or caching
} else {
  console.log('Token not found');
}

Token Validation​

checkPoolExists()​

checkPoolExists(tokenName?, symbol?): Promise<boolean>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8029

Checks if a pool exists (v6.x.0+)

Convenience method that checks pool existence by token name or symbol. At least one parameter is required.

Parameters​

tokenName?​

string

Optional token name to check

symbol?​

string

Optional token symbol to check

Returns​

Promise<boolean>

Promise True if pool exists, false otherwise

Throws​

If neither parameter is provided

Since​

6.x.0

Example​

Check pool existence

const exists = await sdk.checkPoolExists('mytoken');
console.log('Pool exists:', exists);

// Or check by symbol
const existsBySymbol = await sdk.checkPoolExists(undefined, 'MT');
console.log('Pool with symbol MT exists:', existsBySymbol);

isTokenNameAvailable()​

isTokenNameAvailable(tokenName): Promise<boolean>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8055

Check if a token name is available for use

Validates whether a token name is available to be registered on the platform. Token names must be unique across the entire launchpad. Use this before attempting to launch a token to prevent registration failures.

Parameters​

tokenName​

string

Token name to check availability for (letters and digits, up to 25 characters)

Returns​

Promise<boolean>

Promise resolving to true if name is available, false if already taken

Throws​

If tokenName format is invalid

Throws​

If API request fails

Since​

4.0.4-beta.0

Example​

Check name availability before launch

const isAvailable = await sdk.isTokenNameAvailable('mytoken');
if (isAvailable) {
  console.log('Name is available!');
  await sdk.launchToken({ tokenName: 'mytoken', ... });
} else {
  console.log('Name already taken, choose another');
}

isTokenSymbolAvailable()​

isTokenSymbolAvailable(symbol): Promise<boolean>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8081

Check if a token symbol is available for use

Validates whether a token symbol is available to be registered on the platform. Token symbols must be unique across the entire launchpad. Use this before attempting to launch a token to prevent registration failures.

Parameters​

symbol​

string

Token symbol to check availability for (typically 3-6 uppercase characters)

Returns​

Promise<boolean>

Promise resolving to true if symbol is available, false if already taken

Throws​

If symbol format is invalid

Throws​

If API request fails

Since​

4.0.4-beta.0

Example​

Check symbol availability before launch

const isAvailable = await sdk.isTokenSymbolAvailable('MTK');
if (isAvailable) {
  console.log('Symbol is available!');
  await sdk.launchToken({ tokenSymbol: 'MTK', ... });
} else {
  console.log('Symbol already taken, choose another');
}

validateToken()​

validateToken(options): Promise<ValidateTokenResponse>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8120

Validate if token name and/or symbol are available Useful for token creation forms to check availability before submission

Parameters​

options​

Object containing optional tokenName and/or symbol to validate

symbol?​

string

tokenName?​

string

Returns​

Promise<ValidateTokenResponse>

Validation result with availability flags and errors

Since​

6.0.0

Example​

const result = await sdk.validateToken({ tokenName: 'mytoken', symbol: 'MYTKN' });
if (result.nameAvailable && result.symbolAvailable) {
  console.log('Names are available!');
} else {
  console.log('Errors:', result.errors);
}

TokenBan​

banToken()​

banToken(options): Promise<BanTokenResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4813

Ban a token from the platform (overseer only).

When a token is banned:

  • Hidden from ALL pool listings (including creator's profile)
  • Comments blocked on banned tokens
  • Live streaming blocked on banned tokens
  • Chat messages blocked on banned tokens
  • Trading NOT blocked (GalaChain handles trading independently)

Requires either Admin API key or JWT with overseer status.

Parameters​

options​

BanTokenOptions

Ban options including tokenName and optional reason

Returns​

Promise<BanTokenResult>

Created ban data with token name

Throws​

ValidationError if parameters are invalid

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Throws​

Error if token is already banned (409 Conflict)

Since​

6.x.0

Examples​

Ban a token with reason

const result = await sdk.banToken({
  tokenName: 'scamtoken',
  reason: 'Fraudulent project - reported by multiple users'
});
console.log('Banned token:', result.tokenName);
console.log('Ban ID:', result.ban.id);
console.log('Banned by:', result.ban.bannedBy);

Ban without reason

await sdk.banToken({ tokenName: 'problematictoken' });

getTokenBan()​

getTokenBan(options): Promise<TokenBanStatusResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4917

Get ban details for a specific token (overseer only).

Returns ban data if banned, or indicates not banned. Use this to get full ban details including reason and who banned it.

Requires either Admin API key or JWT with overseer status.

Parameters​

options​

GetTokenBanOptions

Options including tokenName

Returns​

Promise<TokenBanStatusResult>

Ban status with full details if banned

Throws​

ValidationError if token name is invalid

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

6.x.0

Example​

const status = await sdk.getTokenBan({ tokenName: 'sometoken' });
if (status.banned) {
  console.log('Token is banned');
  console.log('Reason:', status.ban?.reason);
  console.log('Banned by:', status.ban?.bannedBy);
  console.log('Banned at:', status.ban?.createdAt);
} else {
  console.log('Token is not banned');
}

isTokenBanned()​

isTokenBanned(options): Promise<TokenBanStatusResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4942

Check if a token is banned (overseer only).

Convenience alias for getTokenBan() - provided for semantic clarity. Use when you just need to check if a token is banned.

Requires either Admin API key or JWT with overseer status.

Parameters​

options​

GetTokenBanOptions

Options including tokenName

Returns​

Promise<TokenBanStatusResult>

Ban status with full details if banned

Throws​

ValidationError if token name is invalid

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

6.x.0

Example​

const status = await sdk.isTokenBanned({ tokenName: 'sometoken' });
if (status.banned) {
  console.log('Token is banned:', status.ban?.reason);
}

listTokenBans()​

listTokenBans(options?): Promise<TokenBanListResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4887

List all banned tokens (overseer only).

Returns paginated list of banned tokens with full details.

Requires either Admin API key or JWT with overseer status.

Parameters​

options?​

ListTokenBansOptions

Optional pagination and search parameters

Returns​

Promise<TokenBanListResult>

Paginated list of banned tokens

Throws​

ValidationError if pagination parameters are invalid

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

6.x.0

Examples​

List all banned tokens

const result = await sdk.listTokenBans();
console.log(`Total banned: ${result.pageInfo.totalCount}`);
for (const ban of result.items) {
  console.log(`${ban.tokenName}: ${ban.reason || 'No reason'}`);
}

Search for specific tokens

const result = await sdk.listTokenBans({
  search: 'scam',
  pageSize: 10
});

Paginate through all bans (cursor-based)

let cursor: string | undefined;
let hasMore = true;
while (hasMore) {
  const result = await sdk.listTokenBans({ cursor, pageSize: 20 });
  console.log('Bans:', result.items.map(b => b.tokenName));
  hasMore = result.pageInfo.hasNextPage;
  cursor = result.pageInfo.endCursor ?? undefined;
}

unbanToken()​

unbanToken(options): Promise<UnbanTokenResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4842

Remove a ban from a token (overseer only).

When a token is unbanned:

  • Restored to all pool listings
  • Visible on creator's profile again
  • Comments re-enabled
  • Live streaming re-enabled
  • Chat re-enabled

Requires either Admin API key or JWT with overseer status.

Parameters​

options​

UnbanTokenOptions

Unban options including tokenName

Returns​

Promise<UnbanTokenResult>

Removal confirmation with token name

Throws​

ValidationError if token name is invalid

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Throws​

Error if token is not banned (404 Not Found)

Since​

6.x.0

Example​

const result = await sdk.unbanToken({ tokenName: 'scamtoken' });
console.log('Removed ban:', result.removed); // true
console.log('Token:', result.tokenName);

Trades​

getHolderHistory()​

getHolderHistory(tokenName, userAddress, limit?): Promise<TradesQueryResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1076

Get recent trade history for a specific holder

Returns trades that affected a user's holdings for a token, delegating to getTrades() with userAddress and tokenName filters.

Parameters​

tokenName​

string

Token name (e.g. 'anime')

userAddress​

string

Holder's wallet address

limit?​

number

Number of recent trades to return (default: 20, max: 100)

Returns​

Promise<TradesQueryResult>

Paginated trade history result

Throws​

If tokenName or userAddress is invalid

Since​

9.2.0

Example​

const history = await sdk.getHolderHistory('anime', 'eth|1234...', 10);
history.trades.forEach(t => console.log(`${t.txnType}: ${t.inputAmount} → ${t.outputAmount}`));

getRecentTrades()​

getRecentTrades(tokenName?, limit?): Promise<TradesQueryResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6198

Get the most recently executed trades with optional filtering

Convenience wrapper around getTrades() for quick access to recent market activity. Returns trades sorted by newest first.

Parameters​

tokenName?​

string

Filter by token name (optional)

limit?​

number

Number of recent trades to return (default: 50, max: 500)

Returns​

Promise<TradesQueryResult>

Paginated list of recent trades

Throws​

If API request fails

Since​

9.2.0

Examples​

Get recent trades across all tokens

const { trades } = await sdk.getRecentTrades();
trades.forEach(t => console.log(`${t.tokenName} ${t.txnType}: ${t.inputAmount} → ${t.outputAmount}`));

Get recent trades for a specific token

const { trades } = await sdk.getRecentTrades('anime', 10);
console.log(`Last 10 anime trades`);

getTrades()​

getTrades(options): Promise<TradesQueryResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6172

Get trades with flexible filtering.

Public endpoint - no authentication required. Filter by tokenName, userAddress, or both. At least one filter is required.

This is the unified trades endpoint that provides flexible querying for trade history across tokens and users.

Parameters​

options​

GetTradesOptions

Query options with tokenName and/or userAddress

Returns​

Promise<TradesQueryResult>

Paginated list of trades with metadata

Throws​

ValidationError if neither tokenName nor userAddress provided

Throws​

ValidationError if options contain invalid values

Since​

6.2.0

Examples​

Get all trades for a token

const { trades, pageInfo } = await sdk.getTrades({ tokenName: 'anime' });
console.log(`Found ${trades.length} trades, more: ${pageInfo.hasNextPage}`);
trades.forEach(trade => {
  console.log(`${trade.txnType}: ${trade.inputAmount} -> ${trade.outputAmount}`);
});

Get all trades by a user

const { trades, pageInfo } = await sdk.getTrades({
  userAddress: 'eth|1234567890abcdef...'
});
console.log(`${trades.length} trades across all tokens, more: ${pageInfo.hasNextPage}`);

Get a user's trades on a specific token with pagination

const page = await sdk.getTrades({
  tokenName: 'anime',
  userAddress: 'eth|1234567890abcdef...',
  pageSize: 20
});
console.log(`${page.trades.length} trades, next cursor: ${page.pageInfo.endCursor}`);

Trading Actions​

buy()​

buy(options): Promise<TradeResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7805

Buy tokens with blockchain confirmation and WebSocket monitoring

Executes a buy order on the bonding curve and waits for GalaChain confirmation via WebSocket, returning complete trade details including actual amounts traded, fees paid, and transaction metadata.

Token Format​

Use simple tokenName (e.g., "anime"), NOT full TokenClassKey format.

This method is for bonding curve tokens only (pre-graduation). For DEX trading of graduated tokens, use @gala-chain/gswap-sdk (new GSwap({ signer }).swaps.swap()) with full TokenClassKey format.

// ✅ CORRECT - Simple token name
await sdk.buy({ tokenName: 'anime', amount: '100', type: 'native', ... });

// ❌ WRONG - Do NOT use TokenClassKey format
await sdk.buy({ tokenName: 'Token|Unit|ANIME|client:gala-launchpad', ... }); // Error!

Slippage Protection:

  • Uses expectedAmount to protect against price changes during execution
  • slippageToleranceFactor allows variance (e.g., 0.01 = 1% tolerance)
  • Transaction fails if actual amount deviates beyond tolerance

Transaction Types:

  • type: 'native' - Spend exact GALA amount, receive variable tokens
  • type: 'exact' - Buy exact token amount, spend variable GALA

WebSocket Confirmation:

  • Pre-connects WebSocket before submission to avoid race conditions
  • Blocks until transaction confirmed on GalaChain
  • Returns rich trade result with all transaction details

Parameters​

options​

BuyTokenOptions

Buy options with required tokenName, amount, and slippage protection

Returns​

Promise<TradeResult>

Promise Complete trade result with amounts, fees, and blockchain metadata

Throws​

If wallet not configured or parameters invalid

Throws​

If transaction fails or no transaction ID returned

Throws​

If confirmation fails or times out

Throws​

If price moves beyond tolerance

Since​

1.0.0

Examples​

Buy tokens with GALA (type: 'native')

// Step 1: Calculate expected output
const quote = await sdk.calculateBuyAmount({
  tokenName: 'anime',
  amount: '100',     // 100 GALA
  type: 'native'
});

// Step 2: Execute buy with slippage protection
const result = await sdk.buy({
  tokenName: 'anime',
  amount: '100',                    // Spend 100 GALA
  type: 'native',
  expectedAmount: quote.amount,     // Expected tokens from quote
  slippageToleranceFactor: 0.01    // 1% slippage tolerance
});

console.log('Spent GALA:', result.inputAmount);
console.log('Received tokens:', result.outputAmount);
console.log('Transaction fee:', result.transactionFee);
console.log('Total fees:', result.totalFees);
console.log('Block hash:', result.blockHash);
console.log('Transaction ID:', result.transactionId);

Buy exact token amount (type: 'exact')

// Step 1: Calculate GALA cost
const quote = await sdk.calculateBuyAmount({
  tokenName: 'anime',
  amount: '1000',    // 1000 tokens desired
  type: 'exact'
});

// Step 2: Execute buy
const result = await sdk.buy({
  tokenName: 'anime',
  amount: '1000',                   // Buy exactly 1000 tokens
  type: 'exact',
  expectedAmount: quote.amount,     // Expected GALA cost from quote
  slippageToleranceFactor: 0.02    // 2% slippage tolerance
});

console.log('Bought tokens:', result.outputAmount);  // Should be ~1000
console.log('Spent GALA:', result.inputAmount);

Error handling with slippage

try {
  const result = await sdk.buy({
    tokenName: 'anime',
    amount: '100',
    type: 'native',
    expectedAmount: '950',
    slippageToleranceFactor: 0.01
  });
  console.log('Trade successful:', result.transactionId);
} catch (error) {
  if (error instanceof SlippageError) {
    console.error('Price moved too much:', error.message);
    // Retry with fresh quote
  } else {
    console.error('Trade failed:', error);
  }
}

Trading Data​

fetchTrades()​

fetchTrades(options): Promise<TradesResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1437

Fetch trade history with optional filters and pagination

Retrieves paginated historical trades for a specific token from the Launchpad backend. Supports filtering by trade type (buy/sell), wallet address, and time range for detailed trade analysis and portfolio tracking.

Parameters​

options​

FetchTradesOptions

Trade fetching options with required tokenName

Returns​

Promise<TradesResult>

Promise Paginated trade history with metadata

Throws​

If tokenName is not provided

Throws​

If API request fails

Since​

1.0.0

Examples​

Basic trade history

const trades = await sdk.fetchTrades({
  tokenName: 'anime',
  pageSize: 50
});
console.log(`Found ${trades.total} trades`);
trades.trades.forEach(trade => {
  console.log(`${trade.type}: ${trade.amount} @ ${trade.price}`);
});

Filter by trade type

const buys = await sdk.fetchTrades({
  tokenName: 'anime',
  type: 'buy',
  pageSize: 20
});
console.log(`Recent buy trades: ${buys.trades.length}`);

Filter by wallet and date range

const myTrades = await sdk.fetchTrades({
  tokenName: 'anime',
  address: sdk.getAddress(),
  startDate: new Date('2025-01-01'),
  endDate: new Date('2025-01-31')
});
console.log(`My January trades: ${myTrades.total}`);

fetchVolumeData()​

fetchVolumeData(options): Promise<GraphDataResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1383

Fetch historical trading volume data for charting

Retrieves time-series trading volume data for a specific token, perfect for building volume charts, analyzing trading activity patterns, and monitoring market engagement. Data is aggregated by time period with buy/sell breakdowns.

Parameters​

options​

FetchVolumeDataOptions

Volume data options

Returns​

Promise<GraphDataResult>

{ dataPoints }: { timestamp, value, ... } points, as the backend's chart returns them

Throws​

If tokenName is invalid, or from, to or resolution is missing (MISSING_GRAPH_OPTIONS) or out of range: all three are required although the type marks them optional

Throws​

If API request fails

Since​

4.0.4-beta.0

Example​

Volume over the last 30 days

const now = Math.floor(Date.now() / 1000);
const { dataPoints } = await sdk.fetchVolumeData({
  tokenName: 'anime',
  from: now - 30 * 24 * 60 * 60,
  to: now,
  resolution: 5,
});
dataPoints.forEach((point) => console.log(`${point.timestamp}: ${point.value}`));

User​

getManagedTokens()​

getManagedTokens(options?): Promise<ManagedTokensResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8511

Get all tokens the authenticated user can manage.

Returns a comprehensive view of the user's management capabilities:

  • ownedTokens: Tokens the user created (full OWNER access)
  • moderatedTokens: Tokens with moderator access via claimed invites
  • isOverseer: Whether user has platform-wide overseer access
  • overseerSince: When user became overseer (if applicable)

This is used by the /moderators dashboard page to show all tokens a user can access in Studio.

Requires JWT authentication - call sdk.login() before using this method.

Parameters​

options?​

GetManagedTokensOptions

Optional pagination options (pageSize)

Returns​

Promise<ManagedTokensResult>

Promise resolving to managed tokens result

Throws​

ConfigurationError if JWT auth is not configured

Throws​

ValidationError if pagination parameters are invalid

Since​

5.11.0

Example​

Get all managed tokens

const managed = await sdk.getManagedTokens();

console.log(`Owned tokens: ${managed.ownedTokensCount}`);
console.log(`Moderated tokens: ${managed.moderatedTokensCount}`);
console.log(`Is overseer: ${managed.isOverseer}`);

// List owned tokens with Studio links
managed.ownedTokens.forEach(token => {
  console.log(`${token.tokenName} - ${token.isLive ? 'LIVE' : 'offline'}`);
});

// List moderated tokens with role info
managed.moderatedTokens.forEach(token => {
  console.log(`${token.tokenName} - ${token.role} (${token.inviteScope})`);
});

User Management​

fetchReferralCode()​

fetchReferralCode(): Promise<ReferralCode>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8547

The authenticated user's referral code (GET /v1/connect/users/referrals/code, JWT session; the backend asks Gala Connect for the wallet of the token). Not LaunchpadSDK.fetchReferralUrl, which is the DEX API's link for the SDK wallet.

Returns​

Promise<ReferralCode>

{ code, username? }

Throws​

ConfigurationError if no JWT session is configured

Since​

9.0.0

Example​

const { code } = await sdk.fetchReferralCode();
console.log(`https://pump.gala.com/?ref=${code}`);

getUserGalaBalance()​

getUserGalaBalance(address): Promise<UserGalaBalance>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8530

A user's GALA balance and its USD value, as the launchpad backend reads them from the chain (GET /v1/users/:address/gala-balance). Public; the backend never caches it. For a chain read through the gateway instead, use LaunchpadSDK.fetchGalaBalance.

Parameters​

address​

string

The user's address (eth|..., 0x... or client|...)

Returns​

Promise<UserGalaBalance>

{ name: 'GALA', quantity, price, holdingPrice }

Throws​

ValidationError if no address is given

Throws​

NetworkError if the backend cannot read the balance or the GALA price

Since​

9.0.0

Example​

const gala = await sdk.getUserGalaBalance('eth|1234567890abcdef1234567890abcdef12345678');
console.log(`${gala.quantity} GALA = $${gala.holdingPrice}`);

Utility​

getUrlByTokenName()​

getUrlByTokenName(tokenName): string

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:803

Get the frontend URL for a specific token

Constructs the launchpad frontend URL for viewing/trading a specific token. The base URL is determined by the environment configuration or can be overridden in the SDK config.

Parameters​

tokenName​

string

Token name to generate URL for

Returns​

string

Complete frontend URL for the token

Since​

3.1.0

Examples​

Get token URL

const sdk = new LaunchpadSDK({ wallet, env: 'prod' });
const url = sdk.getUrlByTokenName('dragnrkti');
console.log(url);
// Output: `${getEnvironmentConfig('prod').launchpadFrontendUrl}/buy-sell/dragnrkti`

With custom frontend URL

const sdk = new LaunchpadSDK({
  wallet,
  env: 'stage',
  launchpadFrontendUrl: 'https://custom-frontend.example.com'
});
const url = sdk.getUrlByTokenName('mytoken');
console.log(url);
// Output: https://custom-frontend.example.com/buy-sell/mytoken

Generate URLs for multiple tokens

const tokens = ['dragnrkti', 'rocketri', 'unicornri'];
const urls = tokens.map(token => ({
  token,
  url: sdk.getUrlByTokenName(token)
}));
console.log(urls);

getVersion()​

getVersion(): string

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:760

Get the SDK version

Returns​

string

SDK version string (e.g., "3.12.1")

Since​

3.12.0

Wallet Management​

getWallet()​

getWallet(): Wallet | undefined

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:657

Gets the currently configured wallet

Returns the wallet if configured, or undefined if in read-only mode.

Returns​

Wallet | undefined

The configured wallet, or undefined if not set

Since​

3.23.0

Examples​

Check wallet and get address

const wallet = sdk.getWallet();
if (wallet) {
  console.log('Authenticated as:', wallet.address);
} else {
  console.log('Running in read-only mode');
}

Conditionally perform operations

const wallet = sdk.getWallet();

if (wallet) {
  // Perform authenticated operations
  await sdk.buyTokens('anime', '10', 'native', 0.05);
} else {
  // Perform read-only operations only
  const pools = await sdk.fetchPools();
  const price = await sdk.fetchTokenPrice('anime');
}

hasWallet()​

hasWallet(): boolean

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:705

Checks if a wallet is configured

Useful for conditionally enabling trading operations in UI or determining which operations are available.

Returns​

boolean

true if wallet is configured, false otherwise

Since​

3.23.0

Examples​

Enable/disable trading UI

if (sdk.hasWallet()) {
  // Show trading interface
  renderTradingPanel();
} else {
  // Show connect wallet prompt
  renderConnectWalletPrompt();
}

Graceful fallback

async function buyOrAlert(tokenName: string) {
  if (!sdk.hasWallet()) {
    alert('Please connect wallet to trade');
    return;
  }
  return await sdk.buyTokens(tokenName, '10', 'native', 0.05);
}

setWallet()​

setWallet(wallet): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:578

Sets or updates the wallet for the SDK

Allows dynamic wallet configuration after SDK initialization. Useful for switching between different wallets or upgrading from read-only to signing mode.

Parameters​

wallet​

Wallet

The new wallet to configure

Returns​

void

Throws​

ValidationError if wallet is invalid

Since​

3.23.0

Examples​

Set wallet after initialization

const sdk = createLaunchpadSDK({}); // Start in read-only mode

// Later, when user authenticates...
const userWallet = new ethers.Wallet(process.env.PRIVATE_KEY);
sdk.setWallet(userWallet);

// Now trading operations are available
const result = await sdk.buyTokens('anime', '10', 'native', 0.05);

Switch wallets

const wallet1 = new ethers.Wallet(key1);
sdk.setWallet(wallet1);
await sdk.buyTokens('token', '100', 'native', 0.05);

// Switch to different wallet
const wallet2 = new ethers.Wallet(key2);
sdk.setWallet(wallet2);
await sdk.buyTokens('token', '50', 'native', 0.05);

validateWallet()​

validateWallet(): Wallet

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:537

Type guard that validates a wallet is configured

Throws a ValidationError if the SDK is not configured with a wallet. Use this method to ensure wallet-dependent operations can proceed safely.

Returns​

Wallet

The configured wallet

Throws​

ValidationError if no wallet is configured

Since​

3.23.0

Examples​

Validate wallet before trading

const sdk = createLaunchpadSDK({}); // No wallet

try {
  sdk.validateWallet(); // Throws ValidationError
} catch (error) {
  console.log('Wallet required for trading operations');
}

Use in async function

async function buyTokens(amount: string) {
  const wallet = sdk.validateWallet(); // Throws if not configured
  const result = await sdk.buyTokens('token', amount, 'native', 0.05);
  return result;
}

Watchers​

onLaunchpadTokenCreation()​

onLaunchpadTokenCreation(callback, options?): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9057

Watch for new launchpad token creation events in real-time

Polls for newly created launchpad tokens at regular intervals and invokes the callback for each new token detected. Automatically deduplicates tokens to avoid duplicate callbacks.

Memory Management: This watcher maintains a bounded history of the 1000 most recently seen tokens using LRU (Least Recently Used) cleanup. This prevents unbounded memory growth even when watching for extended periods.

Parameters​

callback​

(token) => void | Promise<void>

Called when a new token is created

options?​

Configuration options for token watching

creatorAddress?​

string

Only notify about tokens created by this address (optional)

intervalMs?​

number

Poll interval in milliseconds (default: 30000 / 30 seconds)

Returns​

Cleanup function to stop watching

() => void

Since​

3.29.0

Examples​

Watch all new tokens

const unsubscribe = sdk.onLaunchpadTokenCreation((token) => {
  console.log(`New token: ${token.name} (${token.symbol})`);
  console.log(`Creator: ${token.creatorAddress}`);
});

// Later: stop watching
unsubscribe();

Watch tokens by specific creator

const unsubscribe = sdk.onLaunchpadTokenCreation(
  (token) => console.log(`${token.name} created!`),
  { creatorAddress: 'eth|1234...' }
);

WebSocket​

realtime​

Get Signature​

get realtime(): StreamWebSocketService

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:1834

The realtime socket: one registry of subscribers for every event the backend emits (token rooms, comment rooms, the global feed, the overseers' firehose, a connection's own user and overseer rooms). Every subscribe* method on it is synchronous, returns that subscriber's own unsubscribe, serves any number of subscribers per event, and joins a room on its first subscriber and leaves it on its last. It also has connect, authenticate, deauthenticate, onConnectionStateChange, onReconnect and the chat / reaction / typing senders.

Created on first use.

Throws​

ConfigurationError if streamWebSocketUrl is not configured

Since​

9.0.0

Returns​

StreamWebSocketService

authenticateStreamWebSocket()​

authenticateStreamWebSocket(token?): Promise<boolean>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6372

Authenticate the stream WebSocket connection.

Required before sending chat messages via WebSocket, and for the user and overseer events. Opens the connection if it is not open. With an app session the token is session.accessToken(), otherwise the SDK's own session token (refreshed when near expiry); pass token to use a specific one, e.g. right after the app refreshed its JWT. After a reconnect the socket re-authenticates itself with the token current at that moment.

Parameters​

token?​

string

JWT to authenticate with (default: the session's current token)

Returns​

Promise<boolean>

Promise resolving true once the server confirms; false when the server rejects the token, does not answer within 10 seconds, the connection drops, there is no token, or a newer authenticateStreamWebSocket / deauthenticateStreamWebSocket call replaced this one

Since​

5.1.0

Example​

Authenticate for chat

await sdk.connectStreamWebSocket();
await sdk.authenticateStreamWebSocket();
// Now can send chat messages via WebSocket

connectStreamWebSocket()​

connectStreamWebSocket(callbacks?): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6347

Connect to the stream WebSocket server.

Establishes a WebSocket connection for real-time stream events. Idempotent and safe to call concurrently (one socket). Subscribing opens it by itself, so calling this is only needed to wait for the connection.

Parameters​

callbacks?​

StreamEventCallbacks

Event callback handlers: each becomes its own subscriber of its event on every token (they join no room, and replace nothing registered before); disconnectStreamWebSocket() removes them

Returns​

Promise<void>

Promise resolving when connected

Throws​

Error if streamWebSocketUrl is not configured

Since​

5.1.0

Example​

Connect with event handlers

await sdk.connectStreamWebSocket({
  onStreamStatus: (event) => {
    console.log(`Stream ${event.tokenName}: ${event.status}`);
  },
  onViewerCount: (event) => {
    console.log(`Viewers: ${event.viewerCount}`);
  },
  onChatMessage: (event) => {
    console.log(`Chat: ${event.content}`);
  },
});

connectWebSocket()​

connectWebSocket(): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8947

Connect to WebSocket for real-time events

Establishes a WebSocket connection for receiving real-time transaction status updates. This method returns immediately - connection happens asynchronously.

Returns​

void

Since​

3.29.0

Examples​

Connect WebSocket

const sdk = createLaunchpadSDK({ wallet });
sdk.connectWebSocket();

Pre-connect before transactions

const sdk = createLaunchpadSDK({ wallet });
sdk.connectWebSocket(); // Connect first

const result = await sdk.buy({ tokenName: 'anime', amount: '10' });
// WebSocket ready to monitor transaction immediately

deauthenticateStreamWebSocket()​

deauthenticateStreamWebSocket(): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6383

Forget the stream socket's authenticated identity (call it when the wallet disconnects).

Cancels a pending authentication and stops re-authenticating on reconnect. The server has no message that drops a connection's identity, so an authenticated socket is closed and opened again: your subscriptions stay registered and are joined again on the new connection.

Returns​

void

Since​

9.0.0

disconnectStreamWebSocket()​

disconnectStreamWebSocket(): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6539

Disconnect from the stream WebSocket server.

Closes the WebSocket connection and releases everything it holds: every subscriber, listener and timer. Unsubscribe functions handed out earlier stay harmless; subscribing again opens a new socket.

Returns​

void

Since​

5.1.0

disconnectWebSocket()​

disconnectWebSocket(): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8962

Disconnect from WebSocket

Closes the WebSocket connection and cleans up all listeners. Safe to call even if not connected.

Returns​

void

Since​

3.29.0

Example​

Disconnect WebSocket

sdk.disconnectWebSocket();

emitDownloadReady()​

emitDownloadReady(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4719

Emit download ready event (admin/overseer only)

Notifies token subscribers that a recording download is ready for consumption.

Parameters​

tokenName​

string

payload​

DownloadReadyPayload

Returns​

Promise<void>

Since​

9.1.0

emitRecordingsCountUpdated()​

emitRecordingsCountUpdated(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4710

Emit recordings count updated event (admin/overseer only)

Notifies token subscribers that the number of available recordings has changed.

Parameters​

tokenName​

string

payload​

RecordingsCountUpdatedPayload

Returns​

Promise<void>

Since​

9.1.0

emitRecordingStatus()​

emitRecordingStatus(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4701

Emit recording status change event (admin/overseer only)

Notifies token subscribers that a Mux recording has changed status (CREATED, READY, or DELETED).

Parameters​

tokenName​

string

payload​

RecordingStatusPayload

Returns​

Promise<void>

Since​

9.1.0

emitTradeExecuted()​

emitTradeExecuted(tokenName, payload): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4636

Emit a trade execution event to token subscribers (admin/overseer only)

Notifies all users subscribed to a token that a trade has executed.

Parameters​

tokenName​

string

Token being traded

payload​

TradeExecutedPayload

Trade details (tradeType, inputAmount, outputAmount)

Returns​

Promise<void>

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

5.15.0

emitWebSocketEvent()​

emitWebSocketEvent(request): Promise<void>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:4623

Emit a generic WebSocket event (admin/overseer only, advanced/custom use).

Low-level escape hatch for event types the boutique emitXxx() methods (emitTradeExecuted, emitChatMessage, etc.) don't cover. Routes to a token room, a user room, or globally depending on which of tokenName/userAddress/broadcast is supplied.

Parameters​

request​

EmitWebSocketEventRequest

action, optional tokenName/userAddress/broadcast, and payload

Returns​

Promise<void>

Throws​

ConfigurationError if neither admin API key nor JWT is configured

Since​

7.1.0

isStreamWebSocketConnected()​

isStreamWebSocketConnected(): boolean

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6548

Check if stream WebSocket is connected.

Returns​

boolean

true if WebSocket is connected

Since​

5.1.0

isWebSocketConnected()​

isWebSocketConnected(): boolean

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:8980

Check if WebSocket is connected

Returns​

boolean

true if WebSocket is currently connected, false otherwise

Since​

3.29.0

Example​

Check connection status

if (sdk.isWebSocketConnected()) {
  console.log('Real-time features enabled');
} else {
  console.log('Real-time features disabled');
}

onAuthenticated()​

onAuthenticated(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7038

Subscribe to WebSocket authentication events

Parameters​

callback​

RealtimeListener<"authenticated">

Handler for authenticated events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onBanEnforcement()​

onBanEnforcement(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6595

Subscribe to ban enforcement events (kick, mute, ban)

Parameters​

callback​

RealtimeListener<"BAN_ENFORCEMENT">

Handler for ban enforcement events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onChatStatusChanged()​

onChatStatusChanged(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6898

Subscribe to chat status changes (enable/disable)

Parameters​

callback​

RealtimeListener<"CHAT_STATUS_CHANGED">

Handler for chat status events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onConnection()​

onConnection(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7028

Subscribe to WebSocket connection events

Parameters​

callback​

RealtimeListener<"connection">

Handler for connection events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onContentFlagged()​

onContentFlagged(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6828

Subscribe to content flagged events (overseer)

Parameters​

callback​

RealtimeListener<"CONTENT_FLAGGED">

Handler for content flagged events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onContentReactionAdded()​

onContentReactionAdded(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6978

Subscribe to content reaction additions

Parameters​

callback​

RealtimeListener<"CONTENT_REACTION_ADDED">

Handler for content reaction added events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onContentReactionRemoved()​

onContentReactionRemoved(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6988

Subscribe to content reaction removals

Parameters​

callback​

RealtimeListener<"CONTENT_REACTION_REMOVED">

Handler for content reaction removed events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onDownloadReady()​

onDownloadReady(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6938

Subscribe to download ready events

Parameters​

callback​

RealtimeListener<"DOWNLOAD_READY">

Handler for download ready events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onEngagementStatsUpdated()​

onEngagementStatsUpdated(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7100

Subscribe to engagement stats update events

Fires after the chat flush job processes messages for a stream, containing updated chat message counts and comment counts for the token. Broadcast to the token room every ~15 seconds when chat activity occurs.

Parameters​

callback​

RealtimeListener<"ENGAGEMENT_STATS_UPDATED">

Handler for engagement stats updated events

Returns​

Unsubscribe

Unsubscribe function

Since​

8.5.0

Example​

const unsubscribe = sdk.onEngagementStatsUpdated((event) => {
  console.log(`${event.tokenName}: ${event.chat.messageCount} chat messages`);
  console.log(`Comments: ${event.comments.count} from ${event.comments.uniqueCommenters} users`);
});

onFlagResolved()​

onFlagResolved(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6838

Subscribe to flag resolved events

Parameters​

callback​

RealtimeListener<"FLAG_RESOLVED">

Handler for flag resolved events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onRecordingsCountUpdated()​

onRecordingsCountUpdated(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6948

Subscribe to recordings count updates

Parameters​

callback​

RealtimeListener<"RECORDINGS_COUNT_UPDATED">

Handler for recordings count updated events

Returns​

Unsubscribe

Unsubscribe function

Since​

9.0.0

onRecordingStatusChanged()​

onRecordingStatusChanged(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6918

Subscribe to recording status changes

Parameters​

callback​

RealtimeListener<"RECORDING_STATUS">

Handler for recording status events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onRoomLeft()​

onRoomLeft(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7078

Subscribe to comment room unsubscription events

Parameters​

callback​

RealtimeListener<"room_left">

Handler for room left events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onRoomSubscribed()​

onRoomSubscribed(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7068

Subscribe to comment room subscription events

Parameters​

callback​

RealtimeListener<"room_subscribed">

Handler for room subscribed events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onSimulcastStatusChanged()​

onSimulcastStatusChanged(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6928

Subscribe to simulcast target status changes

Parameters​

callback​

RealtimeListener<"SIMULCAST_STATUS">

Handler for simulcast status events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onStreamChatDeleted()​

onStreamChatDeleted(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6868

Subscribe to stream chat message deletions

Parameters​

callback​

RealtimeListener<"STREAM_CHAT_DELETED">

Handler for message deleted events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onStreamChatMessage()​

onStreamChatMessage(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6848

Subscribe to new stream chat messages

Parameters​

callback​

RealtimeListener<"STREAM_CHAT_MESSAGE">

Handler for chat message events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onStreamChatPinned()​

onStreamChatPinned(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6878

Subscribe to stream chat message pins

Parameters​

callback​

RealtimeListener<"STREAM_CHAT_PINNED">

Handler for message pinned events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onStreamChatUnpinned()​

onStreamChatUnpinned(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6888

Subscribe to stream chat message unpins

Parameters​

callback​

RealtimeListener<"STREAM_CHAT_UNPINNED">

Handler for message unpinned events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onStreamChatUpdated()​

onStreamChatUpdated(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6858

Subscribe to stream chat message updates

Parameters​

callback​

RealtimeListener<"STREAM_CHAT_UPDATED">

Handler for message updated events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onStreamControlStatusChanged()​

onStreamControlStatusChanged(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7018

Subscribe to stream control status changes

Parameters​

callback​

RealtimeListener<"STREAM_CONTROL_STATUS_CHANGED">

Handler for control status changed events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onStreamCountdownUpdated()​

onStreamCountdownUpdated(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6998

Subscribe to stream countdown updates

Parameters​

callback​

RealtimeListener<"STREAM_COUNTDOWN_UPDATED">

Handler for countdown updated events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onStreamLanguageUpdated()​

onStreamLanguageUpdated(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7008

Subscribe to stream language updates

Parameters​

callback​

RealtimeListener<"STREAM_LANGUAGE_UPDATED">

Handler for language updated events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onStreamReaction()​

onStreamReaction(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6968

Subscribe to stream reactions (emoji)

Parameters​

callback​

RealtimeListener<"STREAM_REACTION">

Handler for stream reaction events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onStreamStatusChanged()​

onStreamStatusChanged(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6565

Subscribe to stream status changes (online/offline)

Parameters​

callback​

RealtimeListener<"STREAM_STATUS">

Handler for stream status events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

Example​

const unsubscribe = sdk.onStreamStatusChanged((event) => {
  console.log(`${event.tokenName}: ${event.status}`);
});

onTokenSubscribed()​

onTokenSubscribed(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7048

Subscribe to token stream room subscription events

Parameters​

callback​

RealtimeListener<"token_subscribed">

Handler for token subscribed events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onTokenUnsubscribed()​

onTokenUnsubscribed(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:7058

Subscribe to token stream room unsubscription events

Parameters​

callback​

RealtimeListener<"token_unsubscribed">

Handler for token unsubscribed events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onUserBanned()​

onUserBanned(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6575

Subscribe to user ban events

Parameters​

callback​

RealtimeListener<"USER_BANNED">

Handler for user banned events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onUserTyping()​

onUserTyping(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6958

Subscribe to user typing indicators

Parameters​

callback​

RealtimeListener<"USER_TYPING">

Handler for user typing events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onUserUnbanned()​

onUserUnbanned(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6585

Subscribe to user unban events

Parameters​

callback​

RealtimeListener<"USER_UNBANNED">

Handler for user unbanned events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

onViewerCountChanged()​

onViewerCountChanged(callback): Unsubscribe

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6908

Subscribe to viewer count changes

Parameters​

callback​

RealtimeListener<"VIEWER_COUNT">

Handler for viewer count events

Returns​

Unsubscribe

Unsubscribe function

Since​

5.12.0

sendStreamChatViaWebSocket()​

sendStreamChatViaWebSocket(tokenName, content): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6445

Send a chat message via WebSocket.

Sends a chat message through the WebSocket connection for lower latency than the REST API. Requires prior authentication.

Parameters​

tokenName​

string

Token name (lowercase)

content​

string

Message content

Returns​

void

Promise resolving when sent

Throws​

Error if not connected or authenticated

Since​

5.1.0

Example​

Send chat via WebSocket

await sdk.connectStreamWebSocket();
await sdk.authenticateStreamWebSocket();
await sdk.subscribeToStream('mytoken');
await sdk.sendStreamChatViaWebSocket('mytoken', 'Hello!');

sendStreamReaction()​

sendStreamReaction(tokenName, emoji, streamTime?): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6474

Send an ephemeral emoji reaction to a live stream.

Reactions are broadcast to all viewers via WebSocket but NOT persisted to database. Rate limiting is enforced server-side (burst of 10, then 0.5/sec refill).

Parameters​

tokenName​

string

Token name (lowercase)

emoji​

string

Emoji to send (single emoji or short sequence, max 15 chars)

streamTime?​

number

Current stream timecode in seconds (for viewer sync, defaults to 0)

Returns​

void

Promise resolving when sent

Throws​

Error if not connected or authenticated

Since​

5.2.0

Example​

Send a reaction during a live stream

await sdk.connectStreamWebSocket({
  onReaction: (e) => console.log(`${e.emoji} from ${e.userAddress}`),
});
await sdk.authenticateStreamWebSocket();
await sdk.subscribeToStream('mytoken');

// Send a heart reaction at current stream position
const currentTime = player.getCurrentTime(); // from MuxPlayer
sdk.sendStreamReaction('mytoken', '❤️', currentTime);

sendTypingStart()​

sendTypingStart(tokenName): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6505

Send a typing indicator start event to a stream chat.

Indicates that the authenticated user has started typing. The indicator auto-clears after 5 seconds of inactivity on the server. Use sendTypingStop() to explicitly stop the indicator.

Requires:

  1. WebSocket connected via connectStreamWebSocket()
  2. Authenticated via authenticateStreamWebSocket()
  3. Subscribed to the stream via subscribeToStream()

Parameters​

tokenName​

string

Token name for the stream chat room

Returns​

void

Throws​

ValidationError if WebSocket not connected or not authenticated

Since​

5.11.0

Example​

Send typing indicator

await sdk.connectStreamWebSocket({
  onTypingIndicator: (e) => console.log(`${e.typingUsers.length} users typing`),
});
await sdk.authenticateStreamWebSocket();
await sdk.subscribeToStream('mytoken');

// User starts typing
sdk.sendTypingStart('mytoken');

sendTypingStop()​

sendTypingStop(tokenName): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6529

Send a typing indicator stop event to a stream chat.

Indicates that the authenticated user has stopped typing. Call this when the user sends a message, clears the input, or blurs the input.

Requires:

  1. WebSocket connected via connectStreamWebSocket()
  2. Authenticated via authenticateStreamWebSocket()
  3. Subscribed to the stream via subscribeToStream()

Parameters​

tokenName​

string

Token name for the stream chat room

Returns​

void

Throws​

ValidationError if WebSocket not connected or not authenticated

Since​

5.11.0

Example​

Stop typing indicator after sending message

await sdk.sendStreamChatViaWebSocket('mytoken', message);
sdk.sendTypingStop('mytoken');

subscribeToEvent()​

subscribeToEvent<T>(channel, callback): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:9018

Subscribe to WebSocket events on a specific channel

Allows custom subscription to WebSocket events. Returns a cleanup function that removes the listener when called.

Type Parameters​

T​

T

Type of event data

Parameters​

channel​

string

Event channel name

callback​

(data) => void

Function called when event is received

Returns​

Cleanup function to unsubscribe from the event

() => void

Since​

3.29.0

Examples​

Subscribe to custom channel

const unsubscribe = sdk.subscribeToEvent<PoolCreatedEvent>(
  'pool:created',
  (event) => {
    console.log(`New pool: ${event.token0}/${event.token1}`);
  }
);

// Later: Stop listening
unsubscribe();

Multiple subscriptions

const cleanup1 = sdk.subscribeToEvent('event1', handler1);
const cleanup2 = sdk.subscribeToEvent('event2', handler2);

// Cleanup all
cleanup1();
cleanup2();

subscribeToStream()​

subscribeToStream(tokenName, callbacks?): Promise<StreamSubscribedEvent>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6410

Subscribe to real-time events for a stream.

Joins the stream room and registers each callback in callbacks as a subscriber of that token. Calling it again for a token ADDS callbacks (it replaces nothing). The room is joined once however many callers share it; use the sdk.realtime.subscribe* methods for subscriptions that are released one by one.

Parameters​

tokenName​

string

Token name (lowercase)

callbacks?​

StreamEventCallbacks

Event callbacks for this token

Returns​

Promise<StreamSubscribedEvent>

Promise resolving when the server confirms the room

Throws​

Error if the connection fails or the server does not confirm within 10 seconds

Since​

5.1.0

Example​

Subscribe to a stream

await sdk.connectStreamWebSocket({
  onStreamStatus: (e) => console.log(`Status: ${e.status}`),
  onViewerCount: (e) => console.log(`Viewers: ${e.viewerCount}`),
});
await sdk.subscribeToStream('mytoken');
// Events will now fire for 'mytoken'

unsubscribeFromStream()​

unsubscribeFromStream(tokenName): void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6422

Remove what subscribeToStream registered for a token.

The token's room is left when no subscriber of any kind remains for it; other subscribers (from sdk.realtime.subscribe*) are untouched.

Parameters​

tokenName​

string

Token name (lowercase)

Returns​

void

Since​

5.1.0

watchBanEnforcement()​

watchBanEnforcement(callback, filters?): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6615

Watch all user ban/unban/enforcement events, normalized into a single stream.

Composes onUserBanned/onUserUnbanned/onBanEnforcement (each a separate real-time channel) into one callback tagged with actionType, and applies the given filters client-side before invoking it - none of the three underlying events are filterable server-side.

Parameters​

callback​

(event) => void

Called for each event that passes the filters

filters?​

Optional filters, all client-side

actionType?​

"BANNED" | "UNBANNED" | "ENFORCEMENT"

Only invoke for 'BANNED' | 'UNBANNED' | 'ENFORCEMENT'

reason?​

string

Only invoke when the event's reason contains this substring

tokenName?​

string

Only invoke for this token (lowercase)

userAddress?​

string

Only invoke for this user address

Returns​

Cleanup function that unsubscribes from all three underlying channels

() => void

Since​

7.1.0

watchCommentCreated()​

watchCommentCreated(callback, filters?): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6658

Watch comment-created events for one token.

Parameters​

callback​

(event) => void

Called for each new comment on the token that passes the filters

filters?​

Must include tokenName; authorAddress/minLength are client-side

authorAddress?​

string

Only invoke for comments from this author

minLength?​

number

Only invoke for comments at least this many characters long

tokenName?​

string

The token to watch (required)

Returns​

Cleanup function

() => void

Throws​

Error if filters.tokenName is missing

Since​

7.1.0

watchHolderCountUpdated()​

watchHolderCountUpdated(callback, filters?): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6676

Watch holder-count-updated events for one token.

Parameters​

callback​

(event) => void

Called whenever the token's holder count changes by at least minThreshold

filters?​

Must include tokenName; minThreshold is client-side

minThreshold?​

number

Only invoke if the holder-count change is at least this large

tokenName?​

string

The token to watch (required)

Returns​

Cleanup function

() => void

Throws​

Error if filters.tokenName is missing

Since​

7.1.0

watchModeratorAdded()​

watchModeratorAdded(callback, filters?): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6692

Watch moderator-added events for one token.

Parameters​

callback​

(event) => void

Called whenever a moderator is added to the token

filters?​

Must include tokenName

tokenName?​

string

The token to watch (required)

Returns​

Cleanup function

() => void

Throws​

Error if filters.tokenName is missing

Since​

7.1.0

watchModeratorChanged()​

watchModeratorChanged(callback, filters?): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6762

Watch moderator added/removed/role-updated events for one token, normalized into a single actionType-tagged stream.

Parameters​

callback​

(event) => void

Called for each moderator change that passes the filters

filters?​

Must include tokenName; eventType and moderatorAddress are client-side

eventType?​

"ADDED" | "REMOVED" | "ROLE_UPDATED"

Only invoke for 'ADDED' | 'REMOVED' | 'ROLE_UPDATED'

moderatorAddress?​

string

Only invoke for this moderator's address

tokenName?​

string

The token to watch (required)

Returns​

Cleanup function that unsubscribes from all three underlying channels

() => void

Throws​

Error if filters.tokenName is missing

Since​

7.1.0

watchPoolMetadataUpdated()​

watchPoolMetadataUpdated(callback, filters?): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6707

Watch pool-metadata-updated events for one token.

Parameters​

callback​

(event) => void

Called whenever the token's pool metadata changes

filters?​

Must include tokenName

tokenName?​

string

The token to watch (required)

Returns​

Cleanup function

() => void

Throws​

Error if filters.tokenName is missing

Since​

7.1.0

watchPoolUpdated()​

watchPoolUpdated(callback, filters?): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6788

Watch pool metadata/social-links/badge-assigned events for one token, normalized into a single updateType-tagged stream.

Parameters​

callback​

(event) => void

Called for each pool update that passes the filters

filters?​

Must include tokenName; updateType is client-side

tokenName?​

string

The token to watch (required)

updateType?​

"METADATA" | "SOCIAL_LINKS" | "BADGE_ASSIGNED"

Only invoke for 'METADATA' | 'SOCIAL_LINKS' | 'BADGE_ASSIGNED'

Returns​

Cleanup function that unsubscribes from all three underlying channels

() => void

Throws​

Error if filters.tokenName is missing

Since​

7.1.0

watchTokenBanChanged()​

watchTokenBanChanged(callback, filters?): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6811

Watch token banned/unbanned events for one token, normalized into a single banStatus-tagged stream (a TOKEN being restricted from trading/creation - distinct from watchBanEnforcement, which bans a USER from chat/platform activity).

Parameters​

callback​

(event) => void

Called for each ban-status change that passes the filters

filters?​

Must include tokenName; banStatus is client-side

banStatus?​

"BANNED" | "UNBANNED"

Only invoke for 'BANNED' | 'UNBANNED'

tokenName?​

string

The token to watch (required)

Returns​

Cleanup function that unsubscribes from both underlying channels

() => void

Throws​

Error if filters.tokenName is missing

Since​

7.1.0

watchTokenBanned()​

watchTokenBanned(callback, filters?): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6744

Watch token-banned events for one token (a token being restricted from trading - distinct from watchBanEnforcement/onUserBanned, which ban a USER from chat/platform activity).

Parameters​

callback​

(event) => void

Called if/when the token is banned

filters?​

Must include tokenName

tokenName?​

string

The token to watch (required)

Returns​

Cleanup function

() => void

Throws​

Error if filters.tokenName is missing

Since​

7.1.0

watchTradeExecuted()​

watchTradeExecuted(callback, filters?): () => void

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:6725

Watch trade-executed events for one token.

Parameters​

callback​

(event) => void

Called for each executed trade on the token that passes the filters

filters?​

Must include tokenName; tradeType/minAmount/userAddress are client-side

minAmount?​

number

Only invoke when inputAmount is at least this large

tokenName?​

string

The token to watch (required)

tradeType?​

"BUY" | "SELL"

Only invoke for 'BUY' or 'SELL' trades

userAddress?​

string

Only invoke for trades from this user address

Returns​

Cleanup function

() => void

Throws​

Error if filters.tokenName is missing

Since​

7.1.0

WeeklyChallenge​

getTokenWeeklyHistory()​

getTokenWeeklyHistory(options): Promise<GetTokenWeeklyHistoryResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5169

Get weekly snapshot history for a specific token.

Returns the last 4 weeks of snapshot data for tracking performance over time.

Public endpoint - no authentication required.

Parameters​

options​

GetTokenWeeklyHistoryOptions

Options with vaultAddress

Returns​

Promise<GetTokenWeeklyHistoryResult>

Array of weekly snapshots with market cap and price data

Throws​

ValidationError if vaultAddress is missing or invalid

Since​

9.0.0

Example​

Get token weekly history

const { snapshots } = await sdk.getTokenWeeklyHistory({
  vaultAddress: 'eth|abc123...'
});

for (const snap of snapshots) {
  const date = new Date(snap.snapshotDate).toLocaleDateString();
  console.log(`${date}: ${snap.marketCapGala} GALA`);
}

// Calculate week-over-week change
if (snapshots.length >= 2) {
  const current = parseFloat(snapshots[0].marketCapGala);
  const previous = parseFloat(snapshots[1].marketCapGala);
  const change = ((current - previous) / previous * 100).toFixed(2);
  console.log(`Week-over-week change: ${change}%`);
}

getWeeklyChallengeLeaderboard()​

getWeeklyChallengeLeaderboard(options?): Promise<GetWeeklyChallengeResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:5134

Get the weekly challenge leaderboard.

Returns tokens ranked by market cap increase for the current challenge week. The challenge week runs Saturday to Friday, with Saturday being the baseline.

Public endpoint - no authentication required.

Parameters​

options?​

GetWeeklyChallengeOptions

Options including limit (1-50, default 10)

Returns​

Promise<GetWeeklyChallengeResult>

Leaderboard with ranked tokens, week dates, and snapshot info

Throws​

ValidationError if limit is out of range

Since​

9.0.0

Example​

Get top 10 tokens in weekly challenge

const { leaderboard } = await sdk.getWeeklyChallengeLeaderboard({ limit: 10 });

console.log(`Week: ${leaderboard.weekStart} to ${leaderboard.weekEnd}`);
console.log(`Total tokens: ${leaderboard.count}`);

for (const token of leaderboard.tokens) {
  console.log(`#${token.rank} ${token.symbol}: +${token.marketCapIncreaseGala} GALA`);
}

Wrap/Unwrap​

estimateUnwrapFee()​

estimateUnwrapFee(tokenId, amount): Promise<WrapUnwrapFeeEstimate>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2513

Estimate fees for an unwrap operation

Calculates expected fees for unwrapping a token back to its native channel. Unwrap operations use automatic fee authorization.

Parameters​

tokenId​

TokenId

Token class key (pipe-delimited string or TokenClassKey; a bare symbol is refused)

amount​

string

Amount to unwrap (decimal string)

Returns​

Promise<WrapUnwrapFeeEstimate>

Promise resolving to fee estimate

Throws​

GalaSDKError TOKEN_NOT_WRAPPABLE, INVALID_WRAP_DIRECTION, INVALID_BRIDGE_AMOUNT

Since​

4.0.18

Example​

Estimate unwrap fee

const estimate = await sdk.estimateUnwrapFee('$GMUSIC|Unit|none|none', '50');
console.log(`Fee: ${estimate.fee} ${estimate.feeToken}`);
console.log(`Auth type: ${estimate.authorizationType}`);

estimateWrapFee()​

estimateWrapFee(tokenId, amount): Promise<WrapUnwrapFeeEstimate>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2491

Estimate fees for a wrap operation

Calculates expected fees for wrapping a token to the asset channel. Wrap operations use cross_channel_authorization fee type.

Parameters​

tokenId​

TokenId

Token class key (pipe-delimited string or TokenClassKey; a bare symbol is refused)

amount​

string

Amount to wrap (decimal string)

Returns​

Promise<WrapUnwrapFeeEstimate>

Promise resolving to fee estimate

Throws​

GalaSDKError TOKEN_NOT_WRAPPABLE, INVALID_WRAP_DIRECTION, INVALID_BRIDGE_AMOUNT

Since​

4.0.18

Example​

Estimate wrap fee

const estimate = await sdk.estimateWrapFee('$MUSIC|Unit|none|none', '100');
console.log(`Fee: ${estimate.fee} ${estimate.feeToken}`);
console.log(`Auth type: ${estimate.authorizationType}`);

unwrapToken()​

unwrapToken(options): Promise<WrapUnwrapResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2469

Unwrap a token back to its native channel

Converts tokens from the asset channel back to their native channel. Reverses a previous wrap operation. Example: GMUSIC (asset channel) → MUSIC (music channel)

Note: This is an internal GalaChain cross-channel operation, NOT an external bridge (Ethereum/Solana).

Parameters​

options​

UnwrapTokenOptions

Unwrap options including tokenId and amount

Returns​

Promise<WrapUnwrapResult>

Promise resolving to the completed unwrap

Throws​

GalaSDKError (@gala-chain/gala-core-sdk): as wrapToken (INVALID_WRAP_DIRECTION for a token not on the asset channel)

Since​

4.0.18

Example​

Unwrap GMUSIC to MUSIC

const result = await sdk.unwrapToken({
  tokenId: '$GMUSIC|Unit|none|none',
  amount: '50'
});
console.log(`Unwrapped ${result.amount} ${result.fromToken} → ${result.toToken}`);

wrapToken()​

wrapToken(options): Promise<WrapUnwrapResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2441

Wrap a token to its asset-channel counterpart

Converts tokens from their native channel to the asset channel. This is required for some tokens to be traded on the DEX. Example: MUSIC (music channel) → GMUSIC (asset channel)

Note: This is an internal GalaChain cross-channel operation, NOT an external bridge (Ethereum/Solana).

Parameters​

options​

WrapTokenOptions

Wrap options including tokenId and amount

Returns​

Promise<WrapUnwrapResult>

Promise resolving to the completed wrap

Throws​

GalaSDKError (@gala-chain/gala-core-sdk): TOKEN_NOT_WRAPPABLE, INVALID_WRAP_DIRECTION (already on the asset channel), INVALID_BRIDGE_OPTION (no wallet), BRIDGE_REQUEST_REJECTED (GalaChain refused it: nothing locked), BRIDGE_OUT_OUTCOME_UNKNOWN (accepted, then failed: never wrap again)

Since​

4.0.18

Examples​

Wrap MUSIC to GMUSIC

// token ids are class keys (a bare symbol such as 'MUSIC' is refused)
const result = await sdk.wrapToken({
  tokenId: '$MUSIC|Unit|none|none',
  amount: '100'
});
console.log(`Wrapped ${result.amount} ${result.fromToken} → ${result.toToken}`);
console.log(`Transaction: ${result.transactionId}`);

With a recipient

const result = await sdk.wrapToken({
  tokenId: '$MUSIC|Unit|none|none',
  amount: '50',
  recipient: 'eth|1234...',
});

Wrappable Tokens​

fetchAllWrappableTokens()​

fetchAllWrappableTokens(): Promise<FetchWrappableTokensResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2314

Fetch ALL wrappable tokens with auto-pagination

Automatically handles pagination to retrieve all wrappable tokens. Returns cached data if available; fetches from API otherwise.

For balance data, use fetchAllWrappableTokenBalances instead.

Returns​

Promise<FetchWrappableTokensResult>

Promise resolving to all wrappable tokens

Throws​

NetworkError if DEX API is unavailable

Since​

4.0.18

Example​

Fetch all wrappable tokens

const result = await sdk.fetchAllWrappableTokens();
console.log(`Total: ${result.tokenCount} tokens`);
result.tokens.forEach(t => {
  console.log(`${t.symbol} ↔ ${t.wrapCounterpart}`);
});

fetchWrappableTokens()​

fetchWrappableTokens(options?): Promise<FetchWrappableTokensResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2290

Fetch wrappable tokens with pagination

Fetches tokens that can be wrapped/unwrapped (e.g., MUSIC ↔ GMUSIC). Results are cached permanently for the SDK lifetime.

For balance data, use fetchWrappableTokenBalances instead.

Parameters​

options?​

FetchWrappableTokensOptions

Fetch options including pagination

Returns​

Promise<FetchWrappableTokensResult>

Promise resolving to fetch result with tokens array

Throws​

NetworkError if DEX API is unavailable

Since​

4.0.18

Example​

Paginated fetch

const result = await sdk.fetchWrappableTokens({
  pageSize: 100
});
console.log(`Found ${result.tokenCount} wrappable tokens`);

getWrapCounterpart()​

getWrapCounterpart(tokenId): Promise<WrappableToken | undefined>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2367

Get the wrap counterpart for a token

Returns the token that the given token can be wrapped/unwrapped to. For example, MUSIC → GMUSIC or GMUSIC → MUSIC.

Parameters​

tokenId​

TokenId

Token identifier (pipe-delimited string or TokenClassKey)

Returns​

Promise<WrappableToken | undefined>

Promise resolving to counterpart token or undefined

Throws​

NetworkError if DEX API is unavailable

Throws​

ValidationError if tokenId format is invalid

Since​

4.0.18

Example​

Get GMUSIC from MUSIC

const counterpart = await sdk.getWrapCounterpart('$MUSIC|Unit|none|none');
console.log(counterpart?.symbol); // "GMUSIC"

getWrappableToken()​

getWrappableToken(tokenId): Promise<WrappableToken | undefined>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2346

Get a wrappable token by tokenId

Uses cache for efficient lookup. If cache not populated, fetches first.

Parameters​

tokenId​

TokenId

Token identifier (pipe-delimited string or TokenClassKey)

Returns​

Promise<WrappableToken | undefined>

Promise resolving to wrappable token or undefined

Throws​

NetworkError if DEX API is unavailable

Throws​

ValidationError if tokenId format is invalid

Since​

4.0.18

Examples​

Get MUSIC token

const token = await sdk.getWrappableToken('$MUSIC|Unit|none|none');
if (token) {
  console.log(`${token.symbol} wraps to ${token.wrapCounterpart}`);
}

Using TokenClassKey object

const token = await sdk.getWrappableToken({
  collection: '$MUSIC',
  category: 'Unit',
  type: 'none',
  additionalKey: 'none'
});

isTokenWrappable()​

isTokenWrappable(tokenId): Promise<IsTokenWrappableResult>

Defined in: packages/launchpad-sdk/dist/LaunchpadSDK.d.ts:2400

Check if a token is wrappable

Returns wrappability status and counterpart token ID if available. Uses cached data for efficient lookups; fetches from API if not cached.

Parameters​

tokenId​

TokenId

Token identifier (pipe-delimited string or TokenClassKey)

Returns​

Promise<IsTokenWrappableResult>

Promise resolving to wrappability check result

Throws​

NetworkError if DEX API is unavailable

Throws​

ValidationError if tokenId format is invalid

Since​

4.0.18

Examples​

Check if MUSIC is wrappable

const result = await sdk.isTokenWrappable('$MUSIC|Unit|none|none');
if (result.isWrappable) {
  console.log(`MUSIC can wrap to: ${result.wrapCounterpart}`);
}

Using TokenClassKey object

const result = await sdk.isTokenWrappable({
  collection: '$MUSIC',
  category: 'Unit',
  type: 'none',
  additionalKey: 'none'
});