Interface SurgeConfig

Configuration options for Surge

interface SurgeConfig {
    apiKey: string;
    chain?: string;
    network?: "mainnet" | "mainnet-beta" | "testnet" | "devnet";
    queue?: Queue;
    gatewayUrl?: string;
    crossbarClient?: CrossbarClient;
    crossbarUrl?: string;
    signatureScheme?: "secp256k1" | "ed25519";
    autoReconnect?: boolean;
    maxReconnectAttempts?: number;
    reconnectDelay?: number;
    verbose?: boolean;
    crossbarMode?: boolean;
}

Properties

apiKey chain? network? queue? gatewayUrl? crossbarClient? crossbarUrl? signatureScheme? autoReconnect? maxReconnectAttempts? reconnectDelay? verbose? crossbarMode?

Properties

apiKey

apiKey: string

API key for authentication

Optionalchain

chain?: string

Chain identifier (defaults to "solana")

Optionalnetwork

network?: "mainnet" | "mainnet-beta" | "testnet" | "devnet"

Network identifier

Optionalqueue

queue?: Queue

Optional queue for gateway discovery

OptionalgatewayUrl

gatewayUrl?: string

Optional gateway URL override

OptionalcrossbarClient

crossbarClient?: CrossbarClient

Optional crossbar client

OptionalcrossbarUrl

crossbarUrl?: string

Optional crossbar URL override (used in crossbar mode)

OptionalsignatureScheme

signatureScheme?: "secp256k1" | "ed25519"

Signature scheme to use (defaults to 'ed25519')

OptionalautoReconnect

autoReconnect?: boolean

Auto-reconnect on connection loss (defaults to true)

OptionalmaxReconnectAttempts

maxReconnectAttempts?: number

Maximum reconnection attempts (defaults to 5)

OptionalreconnectDelay

reconnectDelay?: number

Reconnection delay in ms (defaults to 1000)

Optionalverbose

verbose?: boolean

Verbose flag for added logging

OptionalcrossbarMode

crossbarMode?: boolean

Enable crossbar mode (defaults to false)

Settings

Member Visibility

On This Page

Properties