Class RaindexClient

Fetches orders that were added in a specific transaction

Retrieves all orders created within a single blockchain transaction, useful for tracking order deployment.

Examples

const result = await client.getAddOrdersForTransaction(1, "0x1234567890abcdef1234567890abcdef12345678");
if (result.error) {
  console.error("Cannot fetch added orders:", result.error.readableMsg);
  return;
}
const orders = result.value;
// Do something with orders
Copy

Retrieves all accounts from the orderbook YAML configuration

Returns a map of account configurations where the keys are account names and the values are AccountCfg objects containing account details.

Examples

const result = client.getAllAccounts();
if (result.error) {
  console.error("Error getting accounts:", result.error.readableMsg);
  return;
}
const accounts = result.value;
for (const [name, account] of accounts) {
  console.log(`Account name: ${name}, Address: ${account.address}`);
}
Copy

Retrieves all available networks with their configurations

Returns a comprehensive map of all network configurations available in the orderbook YAML. Each entry contains detailed network information including RPC endpoints and chain-specific settings.

Examples

const result = client.getAllNetworks();
if (result.error) {
  console.error("Error getting networks:", result.error.readableMsg);
  return;
}
const networks = result.value;
for (const [key, config] of networks) {
  console.log(`Network key: ${key}, Chain ID: ${config.chainId}`);
}
Copy

Retrieves all orderbooks from the orderbook YAML configuration

Returns a map of orderbook configurations where the keys are orderbook names and the values are OrderbookCfg objects.

Examples

const result = client.getAllOrderbooks();
if (result.error) {
  console.error("Error getting orderbooks:", result.error.readableMsg);
  return;
}
const orderbooks = result.value;
for (const [name, orderbook] of orderbooks) {
  console.log(`Orderbook: ${name}, Address: ${orderbook.address}, Chain: ${orderbook.network.chainId}`);
}
Copy

Retrieves all tokens from the orderbook YAML configuration

Returns a map of token configurations where the keys are token names and the values are TokenCfg objects containing token details such as address, decimals, symbol, and associated network. This includes both locally defined tokens and any remotely fetched tokens that were cached during client initialization.

Examples

const result = client.getAllTokens();
if (result.error) {
  console.error("Error getting tokens:", result.error.readableMsg);
  return;
}
const tokens = result.value;
for (const [name, token] of tokens) {
  console.log(`Token: ${name}, Address: ${token.address}, Decimals: ${token.decimals}`);
}
Copy

Fetches all unique tokens that exist in vaults.

Retrieves all unique ERC20 tokens that have associated vaults by querying all vaults and extracting their token information, removing duplicates.

Examples

const result = await client.getAllVaultTokens();
if (result.error) {
  console.error("Error fetching tokens:", result.error.readableMsg);
  return;
}
const tokens = result.value;
console.log(`Found ${tokens.length} unique tokens`);
console.log(`Token ${tokens[0].name} in ${tokens[0].chainId}`);
Copy

Retrieves network configuration for a specific chain ID

Finds and returns the network configuration that matches the provided chain ID. This is useful when you need to access network-specific settings like RPC URLs.

Examples

const result = client.getNetworkByChainId(1); // Ethereum mainnet
if (result.error) {
  console.error("Network not found:", result.error.readableMsg);
  return;
}
const networkConfig = result.value;
console.log(`Found network: ${networkConfig}`);
Copy

Retrieves orderbook configuration by contract address

Finds and returns the orderbook configuration that matches the provided contract address. This allows you to access orderbook-specific settings including subgraph endpoints, network information, and other details.

Examples

const result = client.getOrderbookByAddress("0x1234567890123456789012345678901234567890");
if (result.error) {
  console.error("Orderbook not found:", result.error.readableMsg);
  return;
}
const orderbookConfig = result.value;
console.log(`Found orderbook ${orderbookConfig}`);
Copy

Retrieves a specific order by its hash from a particular blockchain network

Fetches complete order details including all vault information, metadata, and performance tracking capabilities for a specific order identified by its hash.

Examples

const result = await client.getOrderByHash(
  137, // Polygon network
  "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"
);
if (result.error) {
  console.error("Error fetching order:", result.error.readableMsg);
  return;
}
const order = result.value;
// Do something with order
Copy

Executes quotes for multiple orders in a single multicall

This function batches all order pairs into one multicall request, which is significantly more efficient than calling getQuotes on each order individually. Results are positionally aligned with the input orders: result[i] contains the quotes for orders[i].

Examples

const orders = (await client.getOrders()).value;
const result = await client.getOrderQuotesBatch(orders, null, null);
if (result.error) {
  console.error("Error:", result.error.readableMsg);
  return;
}
for (const [order, quotes] of orders.map((o, i) => [o, result.value[i]])) {
  console.log("Order", order.orderHash, "quotes:", quotes);
}
Copy

Queries orders with filtering and pagination across configured networks

Retrieves a list of orders from the specified network or all configured networks, with support for filtering by owner, status, and order hash. Results are paginated for efficient data retrieval.

Examples

const result = await client.getOrders(
  137, // Polygon network
  {
    owners: ["0x1234567890abcdef1234567890abcdef12345678"],
    active: true
  },
  1
);
if (result.error) {
  console.error("Error fetching orders:", result.error.readableMsg);
  return;
}
const { orders, totalCount } = result.value;
// Do something with orders
Copy

Fetches orders that were removed in a specific transaction

Retrieves all orders cancelled or removed within a single blockchain transaction. Polls either local DB or subgraph based on the query source.

Examples

const result = await client.getRemoveOrdersForTransaction(1, "0x1234567890abcdef1234567890abcdef12345678");
if (result.error) {
  console.error("Cannot fetch removed orders:", result.error.readableMsg);
  return;
}
const orders = result.value;
// Do something with orders
Copy

Generates calldata for IOrderBookV6.takeOrders4 using a mode + price-cap policy.

This method includes preflight simulation to validate the transaction will succeed and automatically removes failing orders from the config.

The request object contains:

• taker: Address of the account that will execute the takeOrders transaction
• chainId: Chain ID of the target network
• sellToken: Token address the taker will GIVE
• buyToken: Token address the taker will RECEIVE
• mode: One of buyExact, buyUpTo, spendExact, or spendUpTo
• amount: Target amount (output tokens for buy modes, input tokens for spend modes)
• priceCap: human-readable decimal string for max sell per 1 buy

Returns calldata plus pricing info:

• calldata: ABI-encoded bytes for takeOrders4.
• effectivePrice: expected blended sell per 1 buy from the simulation.
• prices: per-leg ratios, best→worst.
• expectedSell: simulated sell at current quotes.
• maxSellCap: amount * priceCap for buy modes, amount for spend modes (worst-case on-chain spend cap).

Example (JS)

const res = await client.getTakeOrdersCalldata({
  chainId: 137,
  taker: "0xTAKER...",
  sellToken: "0xSELL...",
  buyToken: "0xBUY...",
  mode: "buyUpTo",
  amount: "10",
  priceCap: "1.2",
});
if (res.error) {
  console.error(res.error.readableMsg);
} else {
  const { calldata, effectivePrice, expectedSell, maxSellCap, prices, orderbook } = res.value;
}
Copy

Fetches transaction details for a given transaction hash

Retrieves basic transaction information including sender, block number, and timestamp. Polls either local DB or subgraph based on the query source.

Examples

const result = await client.getTransaction(
  1,
  "0x1234567890123456789012345678901234567890",
  "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"
);
if (result.error) {
  console.error("Transaction not found:", result.error.readableMsg);
  return;
}
const transaction = result.value;
// Do something with the transaction
Copy

Retrieves a list of unique chain IDs from all configured networks

Extracts and returns all unique blockchain network chain IDs that are available in the current orderbook configuration.

Examples

const result = client.getUniqueChainIds();
if (result.error) {
  console.error("Error getting chain IDs:", result.error.readableMsg);
  return;
}
const chainIds = result.value;
console.log("Available chains:", chainIds);
Copy

Fetches detailed information for a specific vault

Retrieves complete vault information including token details, balance, etc.

Examples

const result = await client.getVault(
  137, // Polygon network
  "0x1234567890abcdef1234567890abcdef12345678"
);
if (result.error) {
  console.error("Vault not found:", result.error.readableMsg);
  return;
}
const vault = result.value;
// Do something with the vault
Copy

Fetches vault data from multiple subgraphs across different networks

Queries multiple subgraphs simultaneously to retrieve vault information across different networks.

Examples

const result = await client.getVaults(
  {
    owners: ["0x1234567890abcdef1234567890abcdef12345678"],
    hide_zero_balance: true
  },
);
if (result.error) {
  console.error("Error fetching vaults:", result.error.readableMsg);
  return;
}
const vaults = result.value;
// Do something with the vaults
Copy

Checks if Sentry error tracking is enabled in the YAML configuration

Returns true if Sentry is enabled, otherwise returns false.

Examples

const isEnabled = client.isSentryEnabled();
if (isEnabled.error) {
  console.error("Error checking Sentry status:", isEnabled.error.readableMsg);
  return;
}
console.log("Is Sentry enabled?", isEnabled.value);
Copy

Creates a RaindexClient from YAML config, optionally setting up local DB sync automatically when the YAML declares local-db-sync.

Examples

// Subgraph-only (no local-db-sync in YAML)
const result = await RaindexClient.new([yamlConfig]);

// With local DB (YAML has local-db-sync, pass callbacks)
const result = await RaindexClient.new(
  [yamlConfig],
  undefined,
  localDb.query.bind(localDb),
  localDb.wipeAndRecreate.bind(localDb),
  updateStatus,
);
Copy