Class Queue

constructor

• new Queue(program, pubkey): Queue

• Constructs a OnDemandQueue instance.

  Parameters

  • program: Program<Idl>

    The Anchor program instance.
  • pubkey: PublicKey

    The public key of the queue account.

  Returns Queue

Readonly program

Readonly pubkey

addMrEnclaveIx

• addMrEnclaveIx(params): 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;
    }

    • 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.

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.

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.

fetchGateway

• fetchGateway(): Promise<Gateway>

• Loads the queue data from on chain and returns a random gateway.

  Returns Promise<Gateway>

  A promise that resolves to a gateway interface

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.

fetchSignatures

• fetchSignatures(params): 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: OracleJob[];
        maxVariance?: number;
        minResponses?: number;
        numSignatures?: number;
        recentHash?: string;
    }

    • Optional gateway?: string

    • jobs: OracleJob[]

    • Optional maxVariance?: number

    • Optional minResponses?: number

    • Optional numSignatures?: number

    • Optional recentHash?: string

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

  A promise that resolves to the feed evaluation responses.

  Throws

  if the request fails.

fetchSignaturesBatch

• fetchSignaturesBatch(params): Promise<FetchSignaturesBatchResponse>

• Parameters

  • params: {
        feedConfigs: FeedRequest[];
        gateway?: string;
        minResponses?: number;
        queue: PublicKey;
        recentHash?: string;
    }

    • feedConfigs: FeedRequest[]

    • Optional gateway?: string

    • Optional minResponses?: number

    • queue: PublicKey

    • Optional recentHash?: string

  Returns Promise<FetchSignaturesBatchResponse>

fetchSignaturesMulti

• fetchSignaturesMulti(params): Promise<FetchSignaturesMultiResponse>

• Parameters

  • params: {
        feedConfigs: FeedRequest[];
        gateway?: string;
        minResponses?: number;
        queue: PublicKey;
        recentHash?: string;
    }

    • feedConfigs: FeedRequest[]

    • Optional gateway?: string

    • Optional minResponses?: number

    • queue: PublicKey

    • Optional recentHash?: string

  Returns Promise<FetchSignaturesMultiResponse>

initDelegationGroupIx

• initDelegationGroupIx(params): Promise<TransactionInstruction>

• Parameters

  • params: {
        lutSlot?: number;
        overrideStakePool?: PublicKey;
    }

    • Optional lutSlot?: number

    • Optional overrideStakePool?: PublicKey

  Returns Promise<TransactionInstruction>

loadData

• loadData(): Promise<any>

• Loads the queue data for this Queue account from on chain.

  Returns Promise<any>

  A promise that resolves to the queue data.

  Throws

  if the queue account does not exist.

loadLookupTable

• loadLookupTable(): Promise<AddressLookupTableAccount>

• Returns Promise<AddressLookupTableAccount>

lutKey

• lutKey(lutSlot): Promise<PublicKey>

• Parameters

  • lutSlot: number

  Returns Promise<PublicKey>

lutSigner

• lutSigner(): Promise<PublicKey>

• Returns Promise<PublicKey>

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.

rmMrEnclaveIx

• rmMrEnclaveIx(params): 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;
    }

    • 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.

setConfigsIx

• setConfigsIx(params): Promise<TransactionInstruction>

• Sets the queue configurations.

  Parameters

  • params: {
        authority?: PublicKey;
        nodeTimeout?: number;
        reward?: number;
    }

    • Optional authority?: PublicKey

      The new authority for the queue.

    • Optional nodeTimeout?: number

      The new node timeout for the queue.

    • Optional reward?: number

      The new reward for the queue.

  Returns Promise<TransactionInstruction>

  A promise that resolves to the transaction instruction.

setOraclePermissionIx

• setOraclePermissionIx(params): 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

Static createIx

• createIx(program, params): Promise<[Queue, Keypair, TransactionInstruction]>

• Parameters

  • program: Program<Idl>
  • params: {
        allowAuthorityOverrideAfter?: number;
        lutSlot?: number;
        maxQuoteVerificationAge?: number;
        nodeTimeout?: number;
        requireAuthorityHeartbeatPermission?: boolean;
        requireUsagePermission?: boolean;
        reward?: number;
    }

    • Optional allowAuthorityOverrideAfter?: number

    • Optional lutSlot?: number

    • Optional maxQuoteVerificationAge?: number

    • Optional nodeTimeout?: number

    • Optional requireAuthorityHeartbeatPermission?: boolean

    • Optional requireUsagePermission?: boolean

    • Optional reward?: number

  Returns Promise<[Queue, Keypair, TransactionInstruction]>

Static fetchFeedHash

• fetchFeedHash(program, params): Promise<Buffer>

• Parameters

  • program: Program<Idl>
  • params: {
        gateway?: string;
        jobs: OracleJob[];
        maxVariance?: number;
        minResponses?: number;
        numSignatures?: number;
        queue: PublicKey;
        recentHash?: string;
    }

    • Optional gateway?: string

    • jobs: OracleJob[]

    • Optional maxVariance?: number

    • Optional minResponses?: number

    • Optional numSignatures?: number

    • queue: PublicKey

    • Optional recentHash?: string

  Returns Promise<Buffer>

  Deprecated

  Deprecated. Use @switchboard-xyz/common#FeedHash.compute instead.

Static fetchSignatures

• fetchSignatures(program, params): Promise<{
      failures: string[];
      responses: FeedEvalResponse[];
  }>

• Fetches signatures from a random gateway on the queue.

  REST API endpoint: /api/v1/fetch_signatures

  Parameters

  • program: Program<Idl>
  • params: {
        gateway?: string;
        jobs: OracleJob[];
        maxVariance?: number;
        minResponses?: number;
        numSignatures?: number;
        queue: PublicKey;
        recentHash?: string;
    }

    • Optional gateway?: string

    • jobs: OracleJob[]

    • Optional maxVariance?: number

    • Optional minResponses?: number

    • Optional numSignatures?: number

    • queue: PublicKey

    • Optional recentHash?: string

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

  A promise that resolves to the feed evaluation responses.

  Throws

  if the request fails.

Static fetchSignaturesBatch

• fetchSignaturesBatch(program, params): Promise<FetchSignaturesBatchResponse>

• Parameters

  • program: Program<Idl>
  • params: {
        feedConfigs: FeedRequest[];
        gateway?: string;
        minResponses?: number;
        queue: PublicKey;
        recentHash?: string;
    }

    • feedConfigs: FeedRequest[]

    • Optional gateway?: string

    • Optional minResponses?: number

    • queue: PublicKey

    • Optional recentHash?: string

  Returns Promise<FetchSignaturesBatchResponse>

Static fetchSignaturesMulti

• fetchSignaturesMulti(program, params): Promise<FetchSignaturesMultiResponse>

• Parameters

  • program: Program<Idl>
  • params: {
        feedConfigs: FeedRequest[];
        gateway?: string;
        minResponses?: number;
        queue: PublicKey;
        recentHash?: string;
    }

    • feedConfigs: FeedRequest[]

    • Optional gateway?: string

    • Optional minResponses?: number

    • queue: PublicKey

    • Optional recentHash?: string

  Returns Promise<FetchSignaturesMultiResponse>