index/interfaces/SDKConfig.md
Configuration options for the SDK
Extended by
launchpad sdk config
Properties
| Property | Type | Description |
|---|---|---|
accessToken? | string | JWT access token for authenticated requests If provided, the SDK will use this token for JWT-protected endpoints without requiring login(). Token will be auto-refreshed before expiry. Alternative: Call sdk.login() to authenticate with wallet signature. Since 5.2.0 |
accessTokenExpiresIn? | number | Access token expiration in seconds Only used when accessToken is provided directly. Defaults to 86400 (24 hours) if not specified. Since 5.2.0 |
autoRefreshToken? | boolean | Auto-refresh JWT before expiry When enabled (default), the SDK will automatically refresh the JWT token before it expires during requests to JWT-protected endpoints. Refresh occurs when token expires within 5 minutes of request time. Default true Since 5.2.0 |
baseUrl? | string | Base URL for the API (defaults to the prod environment) |
debug? | boolean | Whether to enable debug logging |
devBypass? | boolean | Enable development bypass mode (STAGE only) When enabled in STAGE environment, JWT authentication can be bypassed by appending ?bypass={address} to requests. Useful for testing. WARNING: Only works in STAGE environment. Has no effect in PROD. Default false Since 5.2.0 |
env? | GalaChainEnv | Environment preset (automatically configures all URLs) |
events? | EventsConfig | Events tracking and batching configuration Configure client-side event batching for SDK events ingestion. Events are automatically buffered and flushed in configurable batches to the backend, reducing network overhead. Since 8.2.0 |
headers? | Record<string, string> | Additional headers to include with requests |
pricingConcurrency? | number | Concurrency level for pricing operations on liquidity positions (default: 5) |
streamAdminApiKey? | string | Admin API key for stream management operations Required for admin-only endpoints like disableStream, enableStream. Since 5.1.0 |
streamWebSocketUrl? | string | WebSocket URL for live streaming features Defaults based on environment if not specified. Since 5.1.0 |
timeout? | number | Request timeout in milliseconds |
userApiKey? | string | Per-user API key for MultiAuthGuard endpoints If provided, the SDK will use this key for endpoints protected by MultiAuthGuard (bans, moderators, content flags) as an alternative to JWT authentication. Created via sdk.createApiKey(). Priority: userApiKey > JWT (for MultiAuthGuard endpoints only). Does NOT apply to AdminOrOverseerGuard endpoints (use streamAdminApiKey for those). Since 9.1.0 |
access token expires in auto refresh base url dev bypass gala chain env events config pricing concurrency stream admin api key web socket user