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

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

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

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

Fetches transaction details for a given transaction hash

Retrieves basic transaction information including sender, block number, and timestamp.

Examples

const result = await client.getTransaction(
  "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

Constructor that creates and returns RaindexClient instance directly

Examples

// Single YAML file
const result = await RaindexClient.new([yamlConfig]);
if (result.error) {
  console.error("Init failed:", result.error.readableMsg);
  return;
}
const client = result.value;

// Multiple YAML files (for modular configuration)
const result = await RaindexClient.new([networksYaml, orderbooksYaml, tokensYaml]);
Copy