Interface SurgeConfig

Configuration options for Surge

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

Properties

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

Properties

apiKey

apiKey: string

API key for authentication

OptionalautoReconnect

autoReconnect?: boolean

Auto-reconnect on connection loss (defaults to true)

Optionalchain

chain?: string

Chain identifier (defaults to "solana")

OptionalcrossbarClient

crossbarClient?: CrossbarClient

Optional crossbar client

OptionalcrossbarMode

crossbarMode?: boolean

Enable crossbar mode (defaults to false)

OptionalcrossbarUrl

crossbarUrl?: string

Optional crossbar URL override (used in crossbar mode)

OptionalgatewayUrl

gatewayUrl?: string

Optional gateway URL override

OptionalmaxReconnectAttempts

maxReconnectAttempts?: number

Maximum reconnection attempts (defaults to 5)

Optionalnetwork

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

Network identifier

Optionalqueue

queue?: Queue

Optional queue for gateway discovery

OptionalreconnectDelay

reconnectDelay?: number

Reconnection delay in ms (defaults to 1000)

OptionalsignatureScheme

signatureScheme?: "secp256k1" | "ed25519"

Signature scheme to use (defaults to 'ed25519')

Optionalverbose

verbose?: boolean

Verbose flag for added logging

Settings

Member Visibility

On This Page

Properties