Class Queue

Queue account management for Switchboard On-Demand

The Queue class is the primary interface for interacting with oracle operators in the Switchboard network. It manages:

Oracle operator authorization and verification
Bundle fetching and signature verification
Address lookup table management
Gateway interactions for data retrieval

Key Features

Oracle Management: Track and verify authorized oracle signers
Bundle Operations: Fetch signed data bundles from oracle operators
LUT Optimization: Automatic address lookup table management
Network Detection: Automatic mainnet/devnet queue selection

Example

// Load the default queue for your network
const queue = await Queue.loadDefault(program);

// Fetch a bundle for specific feeds
const [sigVerifyIx, bundle] = await queue.fetchUpdateBundleIx(
  gateway,
  crossbar,
  ['0x1234...', '0x5678...'] // Feed hashes
);

Queue

Constructors

constructor

new Queue(program: Program, pubkey: PublicKey): Queue
Constructs a OnDemandQueue instance.
Parameters
- program: Program
  The Anchor program instance.
- pubkey: PublicKey
  The public key of the queue account.
Returns Queue
- Defined in javascript/on-demand/src/accounts/queue.ts:469

Properties

`Readonly`program

program: Program

The Anchor program instance.

`Readonly`pubkey

pubkey: PublicKey

The public key of the queue account.

`Static` `Readonly`DEFAULT_DEVNET_KEY

DEFAULT_DEVNET_KEY: PublicKey = ...

`Static` `Readonly`DEFAULT_MAINNET_KEY

DEFAULT_MAINNET_KEY: PublicKey = ...

Methods

addMrEnclaveIx

addMrEnclaveIx(
params: { mrEnclave: Uint8Array },
): Promise<TransactionInstruction>
Adds a new MR enclave to the queue. This will allow the queue to accept signatures from the given MR enclave.
Parameters
- params: { mrEnclave: Uint8Array }
Returns Promise<TransactionInstruction>
A promise that resolves to the transaction instruction.

Throws
if the request fails.

Throws
if the MR enclave is already added.

Throws
if the MR enclave is invalid.

Throws
if the MR enclave is not a valid length.
- Defined in javascript/on-demand/src/accounts/queue.ts:661

allowSubsidyIx

allowSubsidyIx(params: { enable: boolean }): Promise<TransactionInstruction>
Parameters
- params: { enable: boolean }
Returns Promise<TransactionInstruction>
- Defined in javascript/on-demand/src/accounts/queue.ts:786

fetchAllGateways

fetchAllGateways(): Promise<Gateway[]>
Loads the queue data from on chain and returns the listed gateways.

Returns Promise<Gateway[]>
A promise that resolves to an array of gateway URIs.
- Defined in javascript/on-demand/src/accounts/queue.ts:494

fetchFreshOracle

fetchFreshOracle(): Promise<PublicKey>
Fetches most recently added and verified Oracle Key.

Returns Promise<PublicKey>
A promise that resolves to an oracle public key.

Throws
if the request fails.
- Defined in javascript/on-demand/src/accounts/queue.ts:847

fetchGateway

fetchGateway(gatewayUrl?: string): Promise<Gateway>
Fetches a gateway interface for interacting with oracle nodes.
Parameters
- OptionalgatewayUrl: string
  Optional URL of a specific gateway to use. If not provided, a random gateway will be selected from the queue's available gateways.
Returns Promise<Gateway>
Gateway - A Gateway instance for making oracle requests

Throws
If no gateways are available on the queue when selecting randomly
- Defined in javascript/on-demand/src/accounts/queue.ts:537

fetchGatewayFromCrossbar

fetchGatewayFromCrossbar(crossbar: CrossbarClient): Promise<Gateway>
Fetches a gateway URL from the Crossbar network

The gateway is the interface to oracle operators. This method automatically detects your network and returns an appropriate gateway for fetching oracle data.
Parameters
- crossbar: CrossbarClient
  Crossbar client instance
Returns Promise<Gateway>
Gateway instance for oracle communication
Example
```
const crossbar = CrossbarClient.default();
const gateway = await queue.fetchGatewayFromCrossbar(crossbar);
```
- Defined in javascript/on-demand/src/accounts/queue.ts:172

fetchOracleKeys

fetchOracleKeys(): Promise<PublicKey[]>
Loads the queue data from on chain and returns the listed oracle keys.

Returns Promise<PublicKey[]>
A promise that resolves to an array of oracle public keys.
- Defined in javascript/on-demand/src/accounts/queue.ts:483

fetchSignatures

fetchSignatures(
    params: {
        gateway?: string;
        jobs: IOracleJob[];
        maxVariance?: number;
        minResponses?: number;
        numSignatures?: number;
        recentHash?: string;
        useTimestamp?: boolean;
    },
): Promise<{ failures: string[]; responses: FeedEvalResponse[] }>
Fetches signatures from a random gateway on the queue.

REST API endpoint: /api/v1/fetch_signatures
Parameters
- params: {
      gateway?: string;
      jobs: IOracleJob[];
      maxVariance?: number;
      minResponses?: number;
      numSignatures?: number;
      recentHash?: string;
      useTimestamp?: boolean;
  }
Returns Promise<{ failures: string[]; responses: FeedEvalResponse[] }>
A promise that resolves to the feed evaluation responses.

Throws
if the request fails.
- Defined in javascript/on-demand/src/accounts/queue.ts:559

fetchSignaturesBatch

fetchSignaturesBatch(
    params: {
        feedConfigs: FeedRequest[];
        gateway?: string;
        numSignatures?: number;
        recentHash?: string;
        useTimestamp?: boolean;
    },
): Promise<FetchSignaturesBatchResponse>
Parameters
- params: {
      feedConfigs: FeedRequest[];
      gateway?: string;
      numSignatures?: number;
      recentHash?: string;
      useTimestamp?: boolean;
  }
Returns Promise<FetchSignaturesBatchResponse>
- Defined in javascript/on-demand/src/accounts/queue.ts:609

fetchSignaturesConsensus

fetchSignaturesConsensus(
    params: {
        feedConfigs: FeedRequest[];
        gateway?: string;
        numSignatures?: number;
        useTimestamp?: boolean;
    },
): Promise<FetchSignaturesConsensusResponse>
Parameters
- params: {
      feedConfigs: FeedRequest[];
      gateway?: string;
      numSignatures?: number;
      useTimestamp?: boolean;
  }
Returns Promise<FetchSignaturesConsensusResponse>
- Defined in javascript/on-demand/src/accounts/queue.ts:595

fetchSignaturesMulti

fetchSignaturesMulti(
    params: {
        feedConfigs: FeedRequest[];
        gateway?: string;
        numSignatures?: number;
        recentHash?: string;
        useTimestamp?: boolean;
    },
): Promise<FetchSignaturesMultiResponse>
Parameters
- params: {
      feedConfigs: FeedRequest[];
      gateway?: string;
      numSignatures?: number;
      recentHash?: string;
      useTimestamp?: boolean;
  }
Returns Promise<FetchSignaturesMultiResponse>
- Defined in javascript/on-demand/src/accounts/queue.ts:579

fetchUpdateBundleIx

fetchUpdateBundleIx(
    gateway: Gateway,
    crossbar: CrossbarClient,
    feedHashes: string[],
    numSignatures?: number,
): Promise<[TransactionInstruction, Buffer<ArrayBufferLike>]>
Fetches oracle bundle and creates verification instruction

This is the primary method for fetching oracle data in the bundle approach. It retrieves signed price data from oracle operators and creates the instruction to verify signatures on-chain.
Parameters
- gateway: Gateway
  Gateway instance for oracle communication
- crossbar: CrossbarClient
  Crossbar client for data routing
- feedHashes: string[]
  Array of feed hashes to fetch (hex strings)
- numSignatures: number = 1
  Number of oracle signatures required (default: 1)
Returns Promise<[TransactionInstruction, Buffer<ArrayBufferLike>]>
Tuple of [signature verification instruction, bundle data]
Example
```
// Fetch prices for BTC and ETH
const [sigVerifyIx, bundle] = await queue.fetchUpdateBundleIx(
  gateway,
  crossbar,
  ['0x1234...', '0x5678...'], // Feed hashes
  3 // Require 3 oracle signatures
);

// Use in your transaction
const tx = await asV0Tx({
  connection,
  ixs: [sigVerifyIx, yourProgramIx],
  signers: [payer],
});
```
- Defined in javascript/on-demand/src/accounts/queue.ts:952

loadData

loadData(): Promise<QueueAccountData>
Loads the queue data for this Queue account from on chain.

Returns Promise<QueueAccountData>
A promise that resolves to the queue data.

Throws
if the queue account does not exist.
- Defined in javascript/on-demand/src/accounts/queue.ts:644

loadLookupTable

loadLookupTable(): Promise<AddressLookupTableAccount>
Returns Promise<AddressLookupTableAccount>
- Defined in javascript/on-demand/src/accounts/queue.ts:906

overrideSVM

overrideSVM(
    params: {
        maxQuoteVerificationAge: number;
        mrEnclave: Buffer;
        oracle: PublicKey;
        secp256k1Signer: Buffer;
        slot: number;
    },
): Promise<TransactionInstruction>
Add an Oracle to a queue and set permissions
Parameters
- params: {
      maxQuoteVerificationAge: number;
      mrEnclave: Buffer;
      oracle: PublicKey;
      secp256k1Signer: Buffer;
      slot: number;
  }
Returns Promise<TransactionInstruction>
- Defined in javascript/on-demand/src/accounts/queue.ts:339

queuePDA

queuePDA(): PublicKey
Get the PDA for the queue (SVM chains that are not solana)

Returns PublicKey
Queue PDA Pubkey
- Defined in javascript/on-demand/src/accounts/queue.ts:887

rmAllMrEnclaveIxs

rmAllMrEnclaveIxs(): Promise<TransactionInstruction[]>
Removes all MR enclaves from the queue.

Returns Promise<TransactionInstruction[]>
A promise that resolves to an array of transaction instructions.

Throws
if the request fails.
- Defined in javascript/on-demand/src/accounts/queue.ts:832

rmMrEnclaveIx

rmMrEnclaveIx(
params: { mrEnclave: Uint8Array },
): Promise<TransactionInstruction>
Removes an MR enclave from the queue. This will prevent the queue from accepting signatures from the given MR enclave.
Parameters
- params: { mrEnclave: Uint8Array }
Returns Promise<TransactionInstruction>
A promise that resolves to the transaction instruction.

Throws
if the request fails.

Throws
if the MR enclave is not present.
- Defined in javascript/on-demand/src/accounts/queue.ts:690

setConfigsIx

setConfigsIx(
params: { authority?: PublicKey; nodeTimeout?: number; reward?: number },
): Promise<TransactionInstruction>
Sets the queue configurations.
Parameters
- params: { authority?: PublicKey; nodeTimeout?: number; reward?: number }
  - Optionalauthority?: PublicKey
    The new authority for the queue.
  - OptionalnodeTimeout?: number
    The new node timeout for the queue.
  - Optionalreward?: number
    The new reward for the queue.
Returns Promise<TransactionInstruction>
A promise that resolves to the transaction instruction.
- Defined in javascript/on-demand/src/accounts/queue.ts:718

setNcnIx

setNcnIx(params: { ncn: PublicKey }): Promise<TransactionInstruction>
Parameters
- params: { ncn: PublicKey }
Returns Promise<TransactionInstruction>
- Defined in javascript/on-demand/src/accounts/queue.ts:743

setOraclePermissionIx

setOraclePermissionIx(
    params: {
        enable: boolean;
        oracle: PublicKey;
        permission: SwitchboardPermission;
    },
): Promise<TransactionInstruction>
Sets the oracle permission on the queue.
Parameters
- params: { enable: boolean; oracle: PublicKey; permission: SwitchboardPermission }
  - enable: boolean
  - oracle: PublicKey
    The oracle to set the permission for.
  - permission: SwitchboardPermission
    The permission to set.
Returns Promise<TransactionInstruction>
A promise that resolves to the transaction instruction
- Defined in javascript/on-demand/src/accounts/queue.ts:812

setVaultIx

setVaultIx(
params: { enable: boolean; vault: PublicKey },
): Promise<TransactionInstruction>
Parameters
- params: { enable: boolean; vault: PublicKey }
Returns Promise<TransactionInstruction>
- Defined in javascript/on-demand/src/accounts/queue.ts:762

`Static`createIx

createIx(
    program: Program,
    params: {
        allowAuthorityOverrideAfter?: number;
        lutSlot?: number;
        maxQuoteVerificationAge?: number;
        nodeTimeout?: number;
        requireAuthorityHeartbeatPermission?: boolean;
        requireUsagePermission?: boolean;
        reward?: number;
    },
): Promise<[Queue, Keypair, TransactionInstruction]>
Creates a new queue account
Parameters
- program: Program
  Anchor program instance
- params: {
      allowAuthorityOverrideAfter?: number;
      lutSlot?: number;
      maxQuoteVerificationAge?: number;
      nodeTimeout?: number;
      requireAuthorityHeartbeatPermission?: boolean;
      requireUsagePermission?: boolean;
      reward?: number;
  }
  Queue configuration parameters
Returns Promise<[Queue, Keypair, TransactionInstruction]>
Tuple of [Queue instance, keypair, creation instruction]
- Defined in javascript/on-demand/src/accounts/queue.ts:193

`Static`createIxSVM

createIxSVM(
    program: Program,
    params: {
        allowAuthorityOverrideAfter?: number;
        lutSlot?: number;
        maxQuoteVerificationAge?: number;
        nodeTimeout?: number;
        requireAuthorityHeartbeatPermission?: boolean;
        requireUsagePermission?: boolean;
        reward?: number;
        sourceQueueKey: PublicKey;
    },
): Promise<[Queue, TransactionInstruction]>
Creates a new instance of the Queue account with a PDA for SVM (non-solana) chains.
Parameters
- program: Program
  The anchor program instance.
- params: {
      allowAuthorityOverrideAfter?: number;
      lutSlot?: number;
      maxQuoteVerificationAge?: number;
      nodeTimeout?: number;
      requireAuthorityHeartbeatPermission?: boolean;
      requireUsagePermission?: boolean;
      reward?: number;
      sourceQueueKey: PublicKey;
  }
  The initialization parameters for the queue.
Returns Promise<[Queue, TransactionInstruction]>
- Defined in javascript/on-demand/src/accounts/queue.ts:263

`Static`fetchFeedHash

fetchFeedHash(
    program: Program,
    params: {
        gateway?: string;
        jobs: IOracleJob[];
        maxVariance?: number;
        minResponses?: number;
        numSignatures?: number;
        queue: PublicKey;
        recentHash?: string;
    },
): Promise<Buffer<ArrayBufferLike>>
Parameters
- program: Program
- params: {
      gateway?: string;
      jobs: IOracleJob[];
      maxVariance?: number;
      minResponses?: number;
      numSignatures?: number;
      queue: PublicKey;
      recentHash?: string;
  }
Returns Promise<Buffer<ArrayBufferLike>>
Deprecated
Deprecated. Use @switchboard-xyz/common#FeedHash.compute instead.
- Defined in javascript/on-demand/src/accounts/queue.ts:446

`Static`fetchSignatures

fetchSignatures(
    program: Program,
    params: {
        gateway?: string;
        jobs: IOracleJob[];
        maxVariance?: number;
        minResponses?: number;
        numSignatures?: number;
        queue: PublicKey;
        recentHash?: string;
    },
): Promise<{ failures: string[]; responses: FeedEvalResponse[] }>
Fetches signatures from a random gateway on the queue.

REST API endpoint: /api/v1/fetch_signatures
Parameters
- program: Program
- params: {
      gateway?: string;
      jobs: IOracleJob[];
      maxVariance?: number;
      minResponses?: number;
      numSignatures?: number;
      queue: PublicKey;
      recentHash?: string;
  }
Returns Promise<{ failures: string[]; responses: FeedEvalResponse[] }>
A promise that resolves to the feed evaluation responses.

Throws
if the request fails.
- Defined in javascript/on-demand/src/accounts/queue.ts:379

`Static`fetchSignaturesBatch

fetchSignaturesBatch(
    program: Program,
    params: {
        feedConfigs: FeedRequest[];
        gateway?: string;
        minResponses?: number;
        queue: PublicKey;
        recentHash?: string;
    },
): Promise<FetchSignaturesBatchResponse>
Parameters
- program: Program
- params: {
      feedConfigs: FeedRequest[];
      gateway?: string;
      minResponses?: number;
      queue: PublicKey;
      recentHash?: string;
  }
Returns Promise<FetchSignaturesBatchResponse>
- Defined in javascript/on-demand/src/accounts/queue.ts:409

`Static`fetchSignaturesConsensus

fetchSignaturesConsensus(
    program: Program,
    params: {
        feedConfigs: FeedRequest[];
        gateway?: string;
        numSignatures?: number;
        queue: PublicKey;
        useTimestamp?: boolean;
    },
): Promise<FetchSignaturesConsensusResponse>
Parameters
- program: Program
- params: {
      feedConfigs: FeedRequest[];
      gateway?: string;
      numSignatures?: number;
      queue: PublicKey;
      useTimestamp?: boolean;
  }
Returns Promise<FetchSignaturesConsensusResponse>
- Defined in javascript/on-demand/src/accounts/queue.ts:423

`Static`fetchSignaturesMulti

fetchSignaturesMulti(
    program: Program,
    params: {
        feedConfigs: FeedRequest[];
        gateway?: string;
        minResponses?: number;
        queue: PublicKey;
        recentHash?: string;
    },
): Promise<FetchSignaturesMultiResponse>
Parameters
- program: Program
- params: {
      feedConfigs: FeedRequest[];
      gateway?: string;
      minResponses?: number;
      queue: PublicKey;
      recentHash?: string;
  }
Returns Promise<FetchSignaturesMultiResponse>
- Defined in javascript/on-demand/src/accounts/queue.ts:395

`Static`loadData

loadData(program: Program, pubkey: PublicKey): Promise<QueueAccountData>
Loads the queue data for this Queue account from on chain.
Parameters
- program: Program
- pubkey: PublicKey
Returns Promise<QueueAccountData>
A promise that resolves to the queue data.

Throws
if the queue account does not exist.
- Defined in javascript/on-demand/src/accounts/queue.ts:631

`Static`loadDefault

loadDefault(program: Program): Promise<Queue>
Loads the default queue for the current network

Automatically detects whether you're on mainnet or devnet and loads the appropriate default queue. This is the recommended way to get started with Switchboard On-Demand.
Parameters
- program: Program
  Anchor program instance
Returns Promise<Queue>
The default queue for your network
Example
```
const queue = await Queue.loadDefault(program);
console.log('Using queue:', queue.pubkey.toBase58());
```
- Defined in javascript/on-demand/src/accounts/queue.ts:144

`Static`queuePDA

queuePDA(program: Program, pubkey: PublicKey): PublicKey
Get the PDA for the queue (SVM chains that are not solana)
Parameters
- program: Program
  Anchor program
- pubkey: PublicKey
  Queue pubkey
Returns PublicKey
Queue PDA Pubkey
- Defined in javascript/on-demand/src/accounts/queue.ts:897

Class Queue

Key Features

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Queue

Properties

Readonlyprogram

Readonlypubkey

Static ReadonlyDEFAULT_DEVNET_KEY

Static ReadonlyDEFAULT_MAINNET_KEY

Methods

addMrEnclaveIx

Parameters

Returns Promise<TransactionInstruction>

Throws

Throws

Throws

Throws

allowSubsidyIx

Parameters

Returns Promise<TransactionInstruction>

fetchAllGateways

Returns Promise<Gateway[]>

fetchFreshOracle

Returns Promise<PublicKey>

Throws

fetchGateway

Parameters

Returns Promise<Gateway>

Throws

fetchGatewayFromCrossbar

Parameters

Returns Promise<Gateway>

Example

fetchOracleKeys

Returns Promise<PublicKey[]>

fetchSignatures

Parameters

Returns Promise<{ failures: string[]; responses: FeedEvalResponse[] }>

Throws

fetchSignaturesBatch

Parameters

Returns Promise<FetchSignaturesBatchResponse>

fetchSignaturesConsensus

Parameters

Returns Promise<FetchSignaturesConsensusResponse>

fetchSignaturesMulti

Parameters

Returns Promise<FetchSignaturesMultiResponse>

fetchUpdateBundleIx

Parameters

Returns Promise<[TransactionInstruction, Buffer<ArrayBufferLike>]>

Example

loadData

Returns Promise<QueueAccountData>

Throws

loadLookupTable

Returns Promise<AddressLookupTableAccount>

overrideSVM

Parameters

Returns Promise<TransactionInstruction>

queuePDA

Returns PublicKey

rmAllMrEnclaveIxs

Returns Promise<TransactionInstruction[]>

Throws

rmMrEnclaveIx

Parameters

Returns Promise<TransactionInstruction>

Throws

Throws

setConfigsIx

Parameters

Optionalauthority?: PublicKey

`Readonly`program

`Readonly`pubkey

`Static` `Readonly`DEFAULT_DEVNET_KEY

`Static` `Readonly`DEFAULT_MAINNET_KEY

`Optional`authority?: PublicKey

`Optional`nodeTimeout?: number

`Optional`reward?: number

`Static`createIx

`Static`createIxSVM

`Static`fetchFeedHash

`Static`fetchSignatures

`Static`fetchSignaturesBatch

`Static`fetchSignaturesConsensus

`Static`fetchSignaturesMulti

`Static`loadData

`Static`loadDefault

`Static`queuePDA