Interface: SDKConfig
Gala Launchpad SDK 9.0.0-rc.5 / index / SDKConfig
Interface: SDKConfig
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:125
Configuration options for the SDK
Extended by
Properties
accessToken?
optionalaccessToken?:string
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:148
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?
optionalaccessTokenExpiresIn?:number
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:157
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?
optionalautoRefreshToken?:boolean
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:169
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?
optionalbaseUrl?:string
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:129
Base URL for the API (defaults to the prod environment)
debug?
optionaldebug?:boolean
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:135
Whether to enable debug logging
devBypass?
optionaldevBypass?:boolean
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:181
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?
optionalenv?:GalaChainEnv
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:127
Environment preset (automatically configures all URLs)
events?
optionalevents?:EventsConfig
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:220
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?
optionalheaders?:Record<string,string>
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:133
Additional headers to include with requests
pricingConcurrency?
optionalpricingConcurrency?:number
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:137
Concurrency level for pricing operations on liquidity positions (default: 5)
streamAdminApiKey?
optionalstreamAdminApiKey?:string
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:197
Admin API key for stream management operations
Required for admin-only endpoints like disableStream, enableStream.
Since
5.1.0
streamWebSocketUrl?
optionalstreamWebSocketUrl?:string
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:189
WebSocket URL for live streaming features
Defaults based on environment if not specified.
Since
5.1.0
timeout?
optionaltimeout?:number
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:131
Request timeout in milliseconds
userApiKey?
optionaluserApiKey?:string
Defined in: packages/launchpad-sdk/dist/types/common.d.ts:210
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