@switchboard-xyz/on-demand

Switchboard On-Demand (typedoc: https://switchboard-docs.web.app)

See the full documentation at Switchboard On-Demand Documentation

Switchboard On-Demand is designed to support high-fidelity financial systems. It allows users to specify how data from both on-chain and off-chain sources is ingested and transformed.

Unlike many pull-based blockchain oracles that manage data consensus on their own Layer 1 (L1) and then propagate it to users—giving oracle operators an advantage—Switchboard Oracles operate inside confidential runtimes. This setup ensures that oracles cannot observe the data they are collecting or the operations they perform, giving the end user a 'first-look' advantage when data is propagated.

Switchboard On-Demand is ideal for blockchain-based financial applications and services, offering a solution that is cost-effective, trustless, and user-friendly.

Key Features:

• User-Created Oracles: In Switchboard, users have the flexibility to build their own oracles according to their specific needs.
• Confidential Runtimes: Oracle operations are performed in a way that even the oracles themselves cannot observe, ensuring data integrity and user advantage.
• High-Fidelity Financial Applications: Designed with financial applications in mind, Switchboard ensures high accuracy and reliability for transactions and data handling.

Browser Compatibility

This library is compatible with both Node.js and browser environments. However, some utility functions require Node.js file system access:

Node.js-Only Functions

• AnchorUtils.initKeypairFromFile() - Use web3.Keypair.fromSecretKey() directly in browsers
• AnchorUtils.initWalletFromFile() - Use browser wallet adapters (e.g., Phantom, Solflare) instead
• AnchorUtils.loadEnv() - Use loadProgramFromConnection() with your own connection/wallet

Browser Usage Example

import * as sb from '@switchboard-xyz/on-demand';
import { CrossbarClient } from '@switchboard-xyz/common';
import { Connection, clusterApiUrl } from '@solana/web3.js';

// Use browser wallet adapter instead of file-based keypair
const connection = new Connection(clusterApiUrl('mainnet-beta'));
const program = await sb.AnchorUtils.loadProgramFromConnection(
  connection,
  walletAdapter // From @solana/wallet-adapter-react or similar
);

// Current Solana/SVM feed-hash updates use the quote program.
const crossbar = CrossbarClient.default();
const queue = await sb.Queue.loadDefault(program);
const feedHash = '0xef0d8b6fcd0104e3e75096912fc8e1e432893da4f18faedaacca7e5875da620f';

const [quoteAccount] = sb.OracleQuote.getCanonicalPubkey(queue.pubkey, [feedHash]);
const updateIxs = await queue.fetchManagedUpdateIxs(crossbar, [feedHash], {
  numSignatures: 3,
  payer: walletAdapter.publicKey,
});

Getting Started

To start building your own on-demand oracle with Switchboard, you can refer to the oracle specification in our documentation.

Feed Parameter Units

Solana helper methods such as PullFeed.initIx and PullFeed.setConfigsIx accept human-percent maxVariance values and scale them by 1e9 internally. Raw v2 OracleFeed.maxJobRangePct values are already scaled integers, so 1_000_000_000 means 1%. minJobResponses and minOracleSamples are unscaled counts. See Feed Parameter Units.

Example Code Snippet:

import * as sb from '@switchboard-xyz/on-demand';
import { CrossbarClient } from '@switchboard-xyz/common';

const crossbar = CrossbarClient.default();
const queue = await sb.Queue.loadDefault(program);
const feedHash = '0xef0d8b6fcd0104e3e75096912fc8e1e432893da4f18faedaacca7e5875da620f';

// Derive the quote-program account that stores the verified feed value.
const [quoteAccount] = sb.OracleQuote.getCanonicalPubkey(queue.pubkey, [feedHash]);

// Fetch Ed25519 verification + quote-program verified_update instructions.
const updateIxs = await queue.fetchManagedUpdateIxs(crossbar, [feedHash], {
    numSignatures: 3,
    payer: payer.publicKey,
});
const tx = await sb.asV0Tx({
    connection,
    ixs: updateIxs,
    signers: [payer],
    computeUnitPrice: 200_000,
    computeUnitLimitMultiple: 1.3,
});
await program.provider.connection.sendTransaction(tx, {
    // preflightCommitment is REQUIRED to be processed or disabled
    preflightCommitment: "processed",
});

For new Solana/SVM feed-hash integrations, read from the derived quoteAccount after the managed update lands. The older PullFeed.fetchUpdateIx() path targets classic PullFeed accounts and requires legacy secp256k1-compatible queue and gateway support.

SwitchboardSurge - Real-time Price Streaming

The SwitchboardSurge class provides real-time price streaming capabilities through WebSocket connections to Switchboard gateways.

Quick Start

import { SwitchboardSurge } from '@switchboard-xyz/on-demand';

// Initialize and subscribe to price feeds
const surge = new SwitchboardSurge({
  apiKey: 'your-api-key',
  gatewayUrl: 'http://localhost:8082', // Your gateway URL
});

// Listen for price updates
surge.on('data', (update) => {
  console.log('Price update:', update.processed.values);
});

// Subscribe to feeds (validation happens automatically)
await surge.subscribe([
  { symbol: 'BTCUSDT', source: 'BINANCE' },
  { symbol: 'ETHUSDT', source: 'BINANCE' },
]);

Event Handling

surge.on('connected', () => {
  console.log('Connected to Switchboard Surge');
});

surge.on('data', (response) => {
  // response.processed: Ready for Solana transactions
  console.log('Feed values:', response.processed.values);
  console.log('Feed hashes:', response.processed.feedHashes);
});

surge.on('error', (error) => {
  console.error('Streaming error:', error.message);
});

surge.on('disconnected', (code, reason) => {
  console.log('Disconnected:', code, reason);
});

Configuration

const surge = new SwitchboardSurge({
  apiKey: 'your-api-key',
  gatewayUrl: 'http://localhost:8082',  // Your gateway URL
  autoReconnect: true,                  // Auto-reconnect on disconnect
  maxReconnectAttempts: 5,              // Max reconnection attempts
  reconnectDelay: 1000,                 // Delay between reconnects (ms)
});

Oracle Quote Functionality

The OracleQuote class provides utilities for working with oracle quote accounts and verified oracle data.

Deriving Oracle Quote Accounts

import { OracleQuote } from '@switchboard-xyz/on-demand';

// Derive the canonical oracle quote account address from feed hashes
const feedHashes = [
  'your-feed-hash-1',
  'your-feed-hash-2'
];

const [oracleAccount, bump] = OracleQuote.getCanonicalPubkey(
  queueKey,   // Queue public key for canonical derivation (required)
  feedHashes  // Uses default program ID
);
console.log('Oracle Quote Account:', oracleAccount.toString());

// Or with a custom program ID:
const [customOracleAccount, customBump] = OracleQuote.getCanonicalPubkey(
  queueKey,
  feedHashes,
  customProgramId
);

The OracleQuote.getCanonicalPubkey() method:

• Takes a queue public key as the first parameter (required)
• Takes an array of feed hashes as the second parameter (32-byte hex strings or Buffers)
• Optionally takes a program ID as the third parameter
• Returns the program-derived address for the oracle quote account
• Uses the default quote program ID orac1eFjzWL5R3RbbdMV68K9H6TaCVVcL6LjvQQWAbz if no program ID is provided
• Matches the Rust implementation for consistent address derivation (queue key + feed hashes as seeds)

Feed Hash Format

Feed hashes must be provided as:

• Hex strings: 64-character hex strings (with or without '0x' prefix)
• Buffers: 32-byte Buffer objects

// Valid formats
const feedHashes = [
  '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
  '1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
  Buffer.from('1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef', 'hex')
];

Reading Stored Quote Accounts

Stored quote-program accounts are variable-length. Do not read feed values by hard-coding byte offsets from a simulation or one account instance. In Rust, use the authoritative SwitchboardQuote account type and its feeds_slice() accessor; each PackedFeedInfo exposes feed_id, feed_value, value(), and min_oracle_samples.

In JavaScript, OracleQuote.decode(...) parses the Ed25519 quote instruction payload used by managed updates. It is not a stable raw account decoder for stored quote-program account data. Until a JS account decoder is provided, use the Rust/on-chain quote types for stored account parsing.

Legacy PullFeed Accounts

PullFeed.fetchUpdateIx() and PullFeed.fetchUpdateManyIx() are compatibility APIs for classic PullFeed accounts. They submit through the classic PullFeed program path, including pullFeedSubmitResponseConsensus, and use the backward-compatible secp256k1 signature flow by default.

Use these methods only when you are maintaining an existing classic PullFeed integration and the target queue/gateway environment explicitly supports that path. New Solana/SVM custom-feed and feed-hash integrations should use Queue.fetchManagedUpdateIxs(...) and canonical OracleQuote accounts instead.