Class Gateway

constructor

• new Gateway(
      program: Program,
      gatewayUrl: string,
      oracleKey?: PublicKey,
  ): Gateway

  Constructs a Gateway instance.

  Parameters

  • program: Program

    The Anchor program instance.
  • gatewayUrl: string

    The URL of the switchboard gateway.
  • OptionaloracleKey: PublicKey

  Returns Gateway

ReadonlygatewayUrl

Optional ReadonlyoracleKey

Readonlyprogram

[toPrimitive]

• "[toPrimitive]"(hint: string): string

  Parameters

  • hint: string

  Returns string

endpoint

• endpoint(): string

  Returns string

fetchAttestation

• fetchAttestation(
      params: {
          oracle_ed25519_enclave_signer: string;
          oracle_pubkey: string;
          oracle_reward_wallet: string;
          oracle_secp256k1_enclave_signer: string;
          quote: string;
          recentHash: string;
          timestamp: number;
      },
  ): Promise<AttestEnclaveResponse>

  Fetches signatures from the gateway. REST API endpoint: /api/v1/gateway_attest_enclave

  Parameters

  • params: {
        oracle_ed25519_enclave_signer: string;
        oracle_pubkey: string;
        oracle_reward_wallet: string;
        oracle_secp256k1_enclave_signer: string;
        quote: string;
        recentHash: string;
        timestamp: number;
    }

  Returns Promise<AttestEnclaveResponse>

  A promise that resolves to the attestation response.

  Throws

  if the request fails.

fetchBridgingMessage

• fetchBridgingMessage(
      params: { chainHash: string; oraclePubkey: string; queuePubkey: string },
  ): Promise<BridgeEnclaveResponse>

  Sends a request to the gateway bridge enclave.

  REST API endpoint: /api/v1/gateway_bridge_enclave

  Parameters

  • params: { chainHash: string; oraclePubkey: string; queuePubkey: string }

  Returns Promise<BridgeEnclaveResponse>

  A promise that resolves to the response.

  Throws

  if the request fails.

fetchQuote

• fetchQuote(
      params: {
          blockhash: string;
          get_for_guardian: boolean;
          get_for_oracle: boolean;
      },
  ): Promise<FetchQuoteResponse[]>

  Fetches a quote from the gateway.

  REST API endpoint: /api/v1/gateway_fetch_quote

  Parameters

  • params: { blockhash: string; get_for_guardian: boolean; get_for_oracle: boolean }

  Returns Promise<FetchQuoteResponse[]>

  A promise that resolves to the quote response.

  Throws

  if the request fails.

fetchRandomnessReveal

• fetchRandomnessReveal(
      params:
          | {
              randomnessAccount: PublicKey;
              rpc?: string;
              slot: number;
              slothash: string;
          }
          | { minStalenessSeconds: number; randomnessId: string; timestamp: number },
  ): Promise<RandomnessRevealResponse>

  Fetches the randomness reveal from the gateway.

  Parameters

  • params:
        | {
            randomnessAccount: PublicKey;
            rpc?: string;
            slot: number;
            slothash: string;
        }
        | { minStalenessSeconds: number; randomnessId: string; timestamp: number }

    The parameters for the randomness reveal.

  Returns Promise<RandomnessRevealResponse>

  The randomness reveal response.

fetchSignatures

• fetchSignatures(
      params: {
          jobs: IOracleJob[];
          maxVariance?: number;
          minResponses?: number;
          numSignatures?: number;
          recentHash?: string;
          useTimestamp?: boolean;
      },
  ): Promise<{ failures: string[]; responses: FeedEvalResponse[] }>

  Fetches signatures from the gateway.

  REST API endpoint: /api/v1/fetch_signatures

  Parameters

  • params: {
        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.

fetchSignaturesBatch

• fetchSignaturesBatch(
      params: {
          feedConfigs: FeedRequest[];
          numSignatures?: number;
          recentHash?: string;
          useTimestamp?: boolean;
      },
  ): Promise<FetchSignaturesBatchResponse>

  Fetches signatures from the gateway without pre-encoded jobs REST API endpoint: /api/v1/fetch_signatures_batch

  Parameters

  • params: {
        feedConfigs: FeedRequest[];
        numSignatures?: number;
        recentHash?: string;
        useTimestamp?: boolean;
    }

  Returns Promise<FetchSignaturesBatchResponse>

  A promise that resolves to the feed evaluation responses.

  Throws

  if the request fails.

fetchSignaturesConsensus

• fetchSignaturesConsensus(
      params: {
          feedConfigs: FeedRequest[];
          numSignatures?: number;
          recentHash?: string;
          useTimestamp?: boolean;
      },
  ): Promise<FetchSignaturesConsensusResponse>

  Parameters

  • params: {
        feedConfigs: FeedRequest[];
        numSignatures?: number;
        recentHash?: string;
        useTimestamp?: boolean;
    }

  Returns Promise<FetchSignaturesConsensusResponse>

fetchSignaturesFromEncoded

• fetchSignaturesFromEncoded(
      params: {
          encodedJobs: string[];
          maxVariance: number;
          minResponses: number;
          numSignatures: number;
          recentHash?: string;
          useTimestamp?: boolean;
      },
  ): Promise<{ failures: string[]; responses: FeedEvalResponse[] }>

  Fetches signatures from the gateway.

  REST API endpoint: /api/v1/fetch_signatures

  Parameters

  • params: {
        encodedJobs: string[];
        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.

fetchSignaturesFromEncodedBatch

• fetchSignaturesFromEncodedBatch(
      params: {
          encodedConfigs: {
              encodedJobs: string[];
              maxVariance: number;
              minResponses: number;
          }[];
          numSignatures: number;
          recentHash?: string;
          useTimestamp?: boolean;
      },
  ): Promise<FetchSignaturesBatchResponse>

  Fetches signatures from the gateway. REST API endpoint: /api/v1/fetch_signatures_batch

  Parameters

  • params: {
        encodedConfigs: {
            encodedJobs: string[];
            maxVariance: number;
            minResponses: number;
        }[];
        numSignatures: number;
        recentHash?: string;
        useTimestamp?: boolean;
    }

  Returns Promise<FetchSignaturesBatchResponse>

  A promise that resolves to the feed evaluation responses.

  Throws

  if the request fails.

fetchSignaturesFromEncodedMulti

• fetchSignaturesFromEncodedMulti(
      params: {
          encodedConfigs: {
              encodedJobs: string[];
              maxVariance: number;
              minResponses: number;
          }[];
          numSignatures: number;
          recentHash?: string;
          useTimestamp?: boolean;
      },
  ): Promise<FetchSignaturesMultiResponse>

  Parameters

  • params: {
        encodedConfigs: {
            encodedJobs: string[];
            maxVariance: number;
            minResponses: number;
        }[];
        numSignatures: number;
        recentHash?: string;
        useTimestamp?: boolean;
    }

  Returns Promise<FetchSignaturesMultiResponse>

fetchSignaturesMulti

• fetchSignaturesMulti(
      params: {
          feedConfigs: FeedRequest[];
          numSignatures?: number;
          recentHash?: string;
          useTimestamp?: boolean;
      },
  ): Promise<FetchSignaturesMultiResponse>

  Parameters

  • params: {
        feedConfigs: FeedRequest[];
        numSignatures?: number;
        recentHash?: string;
        useTimestamp?: boolean;
    }

  Returns Promise<FetchSignaturesMultiResponse>

ping

• ping(): Promise<PingResponse>

  Returns Promise<PingResponse>

test

• test(): Promise<boolean>

  Returns Promise<boolean>

toString

• toString(): string

  Returns string