Skip to main content

Interface: SDKConfig

Gala Launchpad SDK 9.0.0-rc.5


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?​

optional accessToken?: 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?​

optional accessTokenExpiresIn?: 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?​

optional autoRefreshToken?: 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?​

optional baseUrl?: string

Defined in: packages/launchpad-sdk/dist/types/common.d.ts:129

Base URL for the API (defaults to the prod environment)


debug?​

optional debug?: boolean

Defined in: packages/launchpad-sdk/dist/types/common.d.ts:135

Whether to enable debug logging


devBypass?​

optional devBypass?: 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?​

optional env?: GalaChainEnv

Defined in: packages/launchpad-sdk/dist/types/common.d.ts:127

Environment preset (automatically configures all URLs)


events?​

optional events?: 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?​

optional headers?: Record<string, string>

Defined in: packages/launchpad-sdk/dist/types/common.d.ts:133

Additional headers to include with requests


pricingConcurrency?​

optional pricingConcurrency?: number

Defined in: packages/launchpad-sdk/dist/types/common.d.ts:137

Concurrency level for pricing operations on liquidity positions (default: 5)


streamAdminApiKey?​

optional streamAdminApiKey?: 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?​

optional streamWebSocketUrl?: 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?​

optional timeout?: number

Defined in: packages/launchpad-sdk/dist/types/common.d.ts:131

Request timeout in milliseconds


userApiKey?​

optional userApiKey?: 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