Class Surge

Surge - WebSocket streaming client for Switchboard On-Demand feeds

Provides real-time streaming of price updates with automatic processing into Solana transaction instructions. Supports both direct symbol/source subscriptions and feedHash-based subscriptions with automatic detection and conversion.

Example

const surge = new Surge({
  apiKey: "sb_live_...",
  network: "mainnet"
});

// Subscribe to symbol/source pairs
await surge.subscribe([
  { symbol: "BTCUSDT", source: "BINANCE" },
  { symbol: "ETHUSDT", source: "WEIGHTED" }
]);

surge.on('update', (response: SwitchboardOracleResponse) => {
  console.log('Raw:', response.getRawResponse());
  console.log('Formatted prices:', response.getFormattedPrices());
});

Hierarchy

  • EventEmitter
    • Surge

Constructors

constructor

Methods

init connect subscribe validateFeeds connectAndSubscribe subscribeToAll checkFeedExists getFeedInfo unsubscribe disconnect getConnectionState getSubscriptions isSubscribed

Constructors

constructor

Methods

Staticinit

  • init(
        params: { apiKey: string; gateway: string | Gateway; verbose?: boolean },
    ): Surge

    Initialize a Surge instance with a gateway

    Parameters

    • params: { apiKey: string; gateway: string | Gateway; verbose?: boolean }

      Configuration parameters

      • apiKey: string

        The API key for authentication

      • gateway: string | Gateway

        Gateway URL string or Gateway instance

      • Optionalverbose?: boolean

        Whether to enable verbose logging (defaults to false)

    Returns Surge

    A new Surge instance

    Example

    // Using a gateway URL string
    const surge = Surge.init({
      apiKey: "sb_live_...",
      gateway: "https://gateway.switchboard.xyz",
      verbose: true
    });

    // Using a Gateway object
    const gateway = await queue.fetchGatewayFromCrossbar(crossbar);
    const surge = Surge.init({
      apiKey: "sb_live_...",
      gateway: gateway,
    });

connect

subscribe

validateFeeds

  • validateFeeds(feeds: FeedSubscription[], retryCount?: number): Promise<void>

    Validate that feeds exist and sources are available before attempting to subscribe

    Parameters

    • feeds: FeedSubscription[]

      Array of feed subscriptions to validate

    • retryCount: number = 0

      Internal retry counter (defaults to 0)

    Returns Promise<void>

    Throws

    Error if any feed is invalid with descriptive message after retries

connectAndSubscribe

  • connectAndSubscribe(
        feeds: FeedSubscription[],
        batchIntervalMs?: number,
    ): Promise<void>

    Connect to gateway and subscribe to feeds in one operation with proper error handling This is the recommended method for most use cases as it validates feeds before any connection attempts

    Parameters

    • feeds: FeedSubscription[]

      Array of feed subscriptions

    • OptionalbatchIntervalMs: number

    Returns Promise<void>

    Throws

    Error if validation fails, connection fails, or subscription fails

subscribeToAll

checkFeedExists

  • checkFeedExists(symbol: string, source?: string | Source): Promise<boolean>

    Check if a specific feed exists

    Parameters

    • symbol: string

      The symbol to check (e.g., "BTC/USD")

    • Optionalsource: string | Source

      Optional source to check (e.g., Source.WEIGHTED)

    Returns Promise<boolean>

    true if the feed exists

getFeedInfo

unsubscribe

disconnect

getConnectionState

getSubscriptions

isSubscribed

Settings

Member Visibility

On This Page

Constructors
Methods