Class CrossbarClient

Constructors

constructor

new CrossbarClient(crossbarUrl: string, verbose?: boolean): CrossbarClient
Parameters
- crossbarUrl: string
- Optionalverbose: boolean
Returns CrossbarClient
- Defined in crossbar-client.ts:96

Properties

`Readonly`crossbarUrl

crossbarUrl: string

`Readonly`feedCache

feedCache: Map<string, CrossbarFetchResponse> = ...

`Readonly`oracleFeedCache

oracleFeedCache: Map<string, CrossbarOracleFeedFetchResponse> = ...

`Readonly`verbose

verbose: boolean

Methods

fetch

fetch(feedHash: string): Promise<CrossbarFetchResponse>
GET /fetch/:feedHash Fetch data from the crossbar using the provided feedHash
Parameters
- feedHash: string
  The hash of the feed to fetch data for
Returns Promise<CrossbarFetchResponse>
- The data fetched from the crossbar
- Defined in crossbar-client.ts:139

fetchEVMResults

fetchEVMResults(
param0: { aggregatorIds: string[]; chainId: number },
): Promise<{ encoded: string[]; results: EVMResult[] }>
GET /updates/evm/:chainId/:aggregatorIds Fetch updates for EVM network feeds from the crossbar
Parameters
- param0: { aggregatorIds: string[]; chainId: number }
  The chain ID and aggregator IDs to fetch updates for
Returns Promise<{ encoded: string[]; results: EVMResult[] }>
Promise<{ results: EVMResult[]; encoded: string[] }> - The updates for the specified feeds
- Defined in crossbar-client.ts:370

fetchGateway

fetchGateway(network?: string): Promise<Gateway>
Fetch a Gateway instance for the specified network with caching

This method fetches gateway URLs from the crossbar service and creates a Gateway instance. Results are cached per network to avoid repeated network calls.
Parameters
- Optionalnetwork: string
  Network to fetch gateway for (devnet/testnet/mainnet). If not provided, uses the network set via setNetwork()
Returns Promise<Gateway>
- A Gateway instance for the specified network
Throws
If no gateways are available for the specified network
Example
```
const crossbar = CrossbarClient.default();
const gateway = await crossbar.fetchGateway('mainnet');
const response = await gateway.fetchQuote(...);
```
- Defined in crossbar-client.ts:671

fetchGateways

fetchGateways(network?: string): Promise<string[]>
GET /gateways Fetch all gateways from the crossbar
Parameters
- Optionalnetwork: string = 'mainnet'
  Optional network parameter (devnet/testnet/mainnet). Defaults to mainnet.
Returns Promise<string[]>
- The gateways response containing an array of Gateway urls
- Defined in crossbar-client.ts:631

fetchIotaUpdates

fetchIotaUpdates(
network: string,
aggregatorAddresses: string[],
): Promise<{ failures: string[]; responses: IotaAggregatorResponse[] }>
GET /updates/iota/:network/:aggregatorAddresses Fetch updates for Iota network feeds from the crossbar
Parameters
- network: string
  The Iota network to fetch updates for (mainnet / testnet)
- aggregatorAddresses: string[]
  The addresses of the aggregators to fetch updates for
Returns Promise<{ failures: string[]; responses: IotaAggregatorResponse[] }>
- The updates and any failures for the specified feeds
- Defined in crossbar-client.ts:562

fetchOracleFeed

fetchOracleFeed(feedId: string): Promise<CrossbarOracleFeedFetchResponse>
GET /v2/fetch/:feedHash Fetch OracleFeed data from a crossbar server using the provided feedId
Parameters
- feedId: string
  The identifier of the OracleFeed to fetch
Returns Promise<CrossbarOracleFeedFetchResponse>
- The data fetched from the crossbar
- Defined in crossbar-client.ts:177

fetchOracleQuote

fetchOracleQuote(
aggregatorIds: string[],
network?: string,
): Promise<V2UpdateResponse & { encoded: string }>
GET /oracle/quote/:aggregatorIds Fetch the quote for the given aggregator IDs
Parameters
- aggregatorIds: string[]
  The aggregator IDs to fetch the quote for
- network: string = 'mainnet'
  The network to fetch the quote for (mainnet / testnet)
Returns Promise<V2UpdateResponse & { encoded: string }>
- The quote for the given aggregator IDs with timestamp and encoded data
- Defined in crossbar-client.ts:406

fetchOracles

fetchOracles(network?: string): Promise<OracleInfo[]>
GET /oracles Fetch all oracles for a given network
Parameters
- Optionalnetwork: string
  Optional network parameter (devnet/mainnet). Defaults to mainnet.
Returns Promise<OracleInfo[]>
- Array of oracle information
- Defined in crossbar-client.ts:700

fetchSignatures

fetchSignatures(
request: FetchSignaturesRequest,
network?: string,
): Promise<{ failures: string[]; responses: FeedEvalResponse[] }>
POST /gateways/fetch_signatures
Parameters
- request: FetchSignaturesRequest
  The request parameters
- Optionalnetwork: string
  Optional network parameter (devnet/mainnet). Defaults to mainnet.
Returns Promise<{ failures: string[]; responses: FeedEvalResponse[] }>
- Array of oracle signatures and results
Deprecated
Use fetchSignaturesConsensus instead Fetch signatures from oracles for a given set of jobs
- Defined in crossbar-client.ts:726

fetchSignaturesConsensus

fetchSignaturesConsensus(
request: FetchSignaturesConsensusRequest,
network?: string,
): Promise<FetchSignaturesConsensusResponse>

POST /gateways/fetch_signatures_consensus Fetch consensus signatures from oracles for a given set of feed requests

Parameters

request: FetchSignaturesConsensusRequest
The request parameters with camelCase fields
Optionalnetwork: string
Optional network parameter (devnet/mainnet). Defaults to mainnet.

Returns Promise<FetchSignaturesConsensusResponse>

Consensus signatures and median responses in camelCase

Example

// Using FeedRequestV1
const feedRequestV1 = CrossbarClient.createFeedRequestV1(
  ['base64EncodedJob1', 'base64EncodedJob2'],
  1000000, // maxVariance
  3        // minResponses
);

// Using FeedRequestV2
const feedRequestV2 = CrossbarClient.createFeedRequestV2('base64EncodedProtoBuf');

const response = await client.fetchSignaturesConsensus({
  apiVersion: '1.0',
  recentHash: 'someRecentHash',
  signatureScheme: 'ed25519',
  hashScheme: 'sha256',
  feedRequests: [feedRequestV1, feedRequestV2],
  numOracles: 3,
  useTimestamp: false
});

fetchSolanaUpdates

fetchSolanaUpdates(
    network: string,
    feedpubkeys: string[],
    payer: string,
    numSignatures?: number,
): Promise<
    {
        lookupTables: string[];
        pullIxns: TransactionInstruction[];
        responses: { errors: string; oracle: string; result: null
        | number }[];
        success: boolean;
    }[],
>
GET /updates/solana/:network/:feedpubkeys Fetch updates for Solana network feeds from the crossbar
Parameters
- network: string
  The Solana network to fetch updates for
- feedpubkeys: string[]
  The public keys of the feeds to fetch updates for
- payer: string
- OptionalnumSignatures: number
  The number of signatures to fetch (optional)
Returns Promise<
    {
        lookupTables: string[];
        pullIxns: TransactionInstruction[];
        responses: { errors: string; oracle: string; result: null
        | number }[];
        success: boolean;
    }[],
>
- The updates for the specified feeds
- Defined in crossbar-client.ts:285

fetchSuiUpdates

fetchSuiUpdates(
network: string,
aggregatorAddresses: string[],
): Promise<{ failures: string[]; responses: SuiAggregatorResponse[] }>
GET /updates/sui/:network/:aggregatorAddresses Fetch updates for Sui network feeds from the crossbar
Parameters
- network: string
  The Sui network to fetch updates for (mainnet / testnet)
- aggregatorAddresses: string[]
  The addresses of the aggregators to fetch updates for
Returns Promise<{ failures: string[]; responses: SuiAggregatorResponse[] }>
- The updates and any failures for the specified feeds
- Defined in crossbar-client.ts:492

fetchV2Update

fetchV2Update(
feedHashes: string[],
options?: V2UpdateQuery,
): Promise<V2UpdateResponse>

GET /v2/update/{feedHashes} Fetch V2 oracle consensus updates for feed hashes with enhanced chain support

Parameters

feedHashes: string[]
Array of feed hashes to fetch updates for
Optionaloptions: V2UpdateQuery
Optional query parameters for the request

Returns Promise<V2UpdateResponse>

The V2 update response with oracle consensus data

Example

// Basic usage with single feed hash
const response = await client.fetchV2Update(
  ['0x7418dc6408f5e0eb4724dabd81922ee7b0814a43abc2b30ea7a08222cd1e23ee']
);

Example

// With chain-specific options for Sui mainnet
const response = await client.fetchV2Update(
  ['0x7418dc6408f5e0eb4724dabd81922ee7b0814a43abc2b30ea7a08222cd1e23ee'],
  {
    chain: 'sui',
    network: 'mainnet',
    use_timestamp: true,
    num_oracles: 5
  }
);

Example

// Multiple feed hashes with custom gateway
const response = await client.fetchV2Update(
  [
    '0x7418dc6408f5e0eb4724dabd81922ee7b0814a43abc2b30ea7a08222cd1e23ee',
    '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef'
  ],
  {
    network: 'testnet',
    gateway: 'https://custom-gateway.example.com',
    signature_scheme: 'Secp256k1'
  }
);

getNetwork

getNetwork(): string
Get the currently configured default network

Returns string
The current network (mainnet or devnet)
- Defined in crossbar-client.ts:129

resolveEVMRandomness

resolveEVMRandomness(
    param0: { chainId: number; randomnessId: string },
): Promise<
    {
        encoded: string;
        response: { recovery_id: number; signature: string; value: string };
    },
>
GET /randomness/evm/:chainId/:randomnessId
Parameters
- param0: { chainId: number; randomnessId: string }
  The chain ID and randomness ID to resolve
Returns Promise<
    {
        encoded: string;
        response: { recovery_id: number; signature: string; value: string };
    },
>
- Defined in crossbar-client.ts:454

setNetwork

setNetwork(network: CrossbarNetwork): void
Set the default network for CrossbarClient operations

This network will be used as the default for all operations that accept a network parameter. Individual method calls can still override this by passing their own network parameter.
Parameters
- network: CrossbarNetwork
  The network to use (SolanaMainnet or SolanaDevnet)
Returns void
Example
```
const crossbar = CrossbarClient.default();
crossbar.setNetwork(CrossbarNetwork.SolanaDevnet);

// Now all operations will default to devnet
const gateway = await crossbar.fetchGateway(); // Uses devnet
const simResult = await crossbar.simulateFeed(feedId); // Uses devnet
```
- Defined in crossbar-client.ts:120

simulateEVMFeeds

simulateEVMFeeds(
network: number,
aggregatorIds: string[],
): Promise<{ aggregatorId: string; feedHash: string; results: number[] }[]>
GET /simulate/evm/:network/:aggregatorIds Simulate fetching Solana feed results from the crossbar
Parameters
- network: number
  The Solana network to simulate
- aggregatorIds: string[]
  The public keys of the feeds to simulate
Returns Promise<{ aggregatorId: string; feedHash: string; results: number[] }[]>
- The simulated feed results
- Defined in crossbar-client.ts:424

simulateFeed

simulateFeed(
    feedOrHash: string | IOracleFeed,
    includeReceipts?: boolean,
    variableOverrides?: Record<string, string>,
    network?: string,
): Promise<CrossbarSimulateProtoResponse>
POST /v2/simulate/proto Simulate an OracleFeed from a protobuf object or feed hash
Parameters
- feedOrHash: string | IOracleFeed
  The OracleFeed protobuf object or feed hash to simulate
- OptionalincludeReceipts: boolean
  Whether to include receipts in the response
- OptionalvariableOverrides: Record<string, string>
  Variable overrides for the simulation
- Optionalnetwork: string
  Network to use for simulation. If not provided, uses the network set via setNetwork()
Returns Promise<CrossbarSimulateProtoResponse>
- The simulation results
Example
```
const feed = OracleFeed.create({
  name: "BTC/USD",
  jobs: [
    {
      tasks: [
        {
          httpTask: {
            url: "https://api.coinbase.com/v2/prices/BTC-USD/spot"
          }
        },
        {
          jsonParseTask: {
            path: "$.data.amount"
          }
        }
      ]
    }
  ]
});

const response = await client.simulateFeed(
  feed,
  true,
  { MY_VAR: "value" },
  "mainnet"
);
```
- Defined in crossbar-client.ts:973

simulateFeeds

simulateFeeds(
feedHashes: string[],
includeReceipts?: boolean,
): Promise<CrossbarSimulateProtoResponse[]>
Simulate fetching feed results from the crossbar using feed hashes
Parameters
- feedHashes: string[]
  The hashes of the feeds to simulate
- OptionalincludeReceipts: boolean
  Whether to include receipts in the response
Returns Promise<CrossbarSimulateProtoResponse[]>
- The simulated feed results
- Defined in crossbar-client.ts:1025

simulateIotaFeeds

simulateIotaFeeds(
    network: string,
    aggregatorAddresses: string[],
    includeReceipts?: boolean,
): Promise<SuiSimulationResult[]>
GET /simulate/iota/:network/:aggregatorAddresses Simulate fetching Iota feed results from the crossbar
Parameters
- network: string
  The Iota network to simulate (mainnet / testnet)
- aggregatorAddresses: string[]
  The feed IDs to simulate
- OptionalincludeReceipts: boolean
  Whether to include receipts in the response
Returns Promise<SuiSimulationResult[]>
- The simulated feed results
- Defined in crossbar-client.ts:596

simulateJobs

simulateJobs(request: SimulateJobsRequest): Promise<SimulateJobsResponse>

POST /simulate/jobs Simulate oracle jobs execution without storing them

Parameters

request: SimulateJobsRequest
The simulation request containing jobs and optional parameters

Returns Promise<SimulateJobsResponse>

The simulation results

Example

const response = await client.simulateJobs({
  jobs: [
    {
      tasks: [
        {
          httpTask: {
            url: "https://api.coinbase.com/v2/prices/BTC-USD/spot"
          }
        },
        {
          jsonParseTask: {
            path: "$.data.amount"
          }
        }
      ]
    }
  ],
  includeReceipts: true,
  variableOverrides: {
    MY_VARIABLE: "custom_value"
  }
});

simulateOracleFeeds

simulateOracleFeeds(
    feedHashes: string[],
    includeReceipts?: boolean,
    variableOverrides?: Record<string, string>,
    network?: string,
): Promise<CrossbarSimulateProtoResponse[]>
Simulate V2 oracle feeds with variable overrides and network selection
Parameters
- feedHashes: string[]
  The hashes of the V2 feeds to simulate
- OptionalincludeReceipts: boolean
  Whether to include receipts in the response
- OptionalvariableOverrides: Record<string, string>
  Variable overrides for the simulation
- Optionalnetwork: string
  Network to use for simulation (defaults to "mainnet")
Returns Promise<CrossbarSimulateProtoResponse[]>
- The simulated feed results
Deprecated
Use simulateFeeds instead
- Defined in crossbar-client.ts:1046

simulateSolanaFeeds

simulateSolanaFeeds(
network: string,
feedpubkeys: string[],
): Promise<{ feed: string; feedHash: string; results: number[] }[]>
GET /simulate/solana/:network/:feedpubkeys Simulate fetching Solana feed results from the crossbar
Parameters
- network: string
  The Solana network to simulate
- feedpubkeys: string[]
  The public keys of the feeds to simulate
Returns Promise<{ feed: string; feedHash: string; results: number[] }[]>
- The simulated feed results
- Defined in crossbar-client.ts:338

simulateSuiFeeds

simulateSuiFeeds(
    network: string,
    aggregatorAddresses: string[],
    includeReceipts?: boolean,
): Promise<SuiSimulationResult[]>
GET /simulate/sui/:network/:aggregatorAddresses Simulate fetching Sui feed results from the crossbar
Parameters
- network: string
  The Sui network to simulate (mainnet / testnet)
- aggregatorAddresses: string[]
  The feed IDs to simulate
- OptionalincludeReceipts: boolean
  Whether to include receipts in the response
Returns Promise<SuiSimulationResult[]>
- The simulated feed results
- Defined in crossbar-client.ts:526

store

store(
queueAddress: string,
jobs: IOracleJob[],
): Promise<{ cid: string; feedHash: string; queueHex: string }>
POST /store Store oracle jobs on the crossbar, associated with a queue address
Parameters
- queueAddress: string
  The address of the queue
- jobs: IOracleJob[]
  The oracle jobs to store
Returns Promise<{ cid: string; feedHash: string; queueHex: string }>
- The stored data information
- Defined in crossbar-client.ts:215

storeOracleFeed

storeOracleFeed(feed: IOracleFeed): Promise<{ cid: string; feedId: string }>
POST /v2/store Store an OracleFeed on IPFS using crossbar.
Parameters
- feed: IOracleFeed
  The OracleFeed to store
Returns Promise<{ cid: string; feedId: string }>
- The stored data information
- Defined in crossbar-client.ts:252

`Static`createFeedRequestV1

createFeedRequestV1(
    jobsB64Encoded: string[],
    maxVariance: number,
    minResponses: number,
): FeedRequest
Create a FeedRequestV1 object
Parameters
- jobsB64Encoded: string[]
  Base64 encoded oracle jobs
- maxVariance: number
  Maximum variance allowed for the feed
- minResponses: number
  Minimum number of oracle responses required
Returns FeedRequest
- A FeedRequestV1 object
- Defined in crossbar-client.ts:63

`Static`createFeedRequestV2

createFeedRequestV2(feedProtoB64: string): FeedRequest
Create a FeedRequestV2 object
Parameters
- feedProtoB64: string
  Base64 encoded feed protobuf
Returns FeedRequest
- A FeedRequestV2 object
- Defined in crossbar-client.ts:80

`Static`default

default(verbose?: boolean): CrossbarClient
Parameters
- Optionalverbose: boolean
Returns CrossbarClient
- Defined in crossbar-client.ts:86

Class CrossbarClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CrossbarClient

Properties

ReadonlycrossbarUrl

ReadonlyfeedCache

ReadonlyoracleFeedCache

Readonlyverbose

Methods

fetch

Parameters

Returns Promise<CrossbarFetchResponse>

fetchEVMResults

Parameters

Returns Promise<{ encoded: string[]; results: EVMResult[] }>

fetchGateway

Parameters

Returns Promise<Gateway>

Throws

Example

fetchGateways

Parameters

Returns Promise<string[]>

fetchIotaUpdates

Parameters

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

fetchOracleFeed

Parameters

Returns Promise<CrossbarOracleFeedFetchResponse>

fetchOracleQuote

Parameters

Returns Promise<V2UpdateResponse & { encoded: string }>

fetchOracles

Parameters

Returns Promise<OracleInfo[]>

fetchSignatures

Parameters

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

Deprecated

fetchSignaturesConsensus

Parameters

Returns Promise<FetchSignaturesConsensusResponse>

Example

fetchSolanaUpdates

Parameters

Returns Promise< { lookupTables: string[]; pullIxns: TransactionInstruction[]; responses: { errors: string; oracle: string; result: null | number }[]; success: boolean; }[],>

fetchSuiUpdates

Parameters

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

fetchV2Update

Parameters

Returns Promise<V2UpdateResponse>

Example

Example

Example

getNetwork

Returns string

resolveEVMRandomness

Parameters

Returns Promise< { encoded: string; response: { recovery_id: number; signature: string; value: string }; },>

setNetwork

Parameters

Returns void

Example

simulateEVMFeeds

Parameters

Returns Promise<{ aggregatorId: string; feedHash: string; results: number[] }[]>

simulateFeed

Parameters

Returns Promise<CrossbarSimulateProtoResponse>

Example

simulateFeeds

Parameters

Returns Promise<CrossbarSimulateProtoResponse[]>

`Readonly`crossbarUrl

`Readonly`feedCache

`Readonly`oracleFeedCache

`Readonly`verbose

Returns Promise<
{
lookupTables: string[];
pullIxns: TransactionInstruction[];
responses: { errors: string; oracle: string; result: null
| number }[];
success: boolean;
}[],
>

Returns Promise<
{
encoded: string;
response: { recovery_id: number; signature: string; value: string };
},
>

`Static`createFeedRequestV1

`Static`createFeedRequestV2

`Static`default