Class RaindexOrderBuilder

Exports the current configuration as a complete dotrain text file.

This generates a valid dotrain file with YAML frontmatter and Rainlang code, preserving all configurations and bindings. Useful for saving or sharing orders.

Format

The output follows the standard dotrain format:

builder:
  ...
---
#binding1 !The binding value
#calculate-io
...
Copy

Examples

const result = builder.generateDotrainText();
if (result.error) {
  console.error("Export failed:", result.error.readableMsg);
  return;
}
const dotrain = result.value;
// Do something with the dotrain
Copy

Gets information for all tokens used in the current deployment's order.

This function automatically determines which tokens to fetch based on the deployment:

• If select-tokens is defined, returns info for those tokens
• Otherwise, returns info for all input/output tokens in the order

Performance Note

This may trigger multiple blockchain queries if token data isn't cached in YAML. Consider caching the results in your application.

Examples

const result = await builder.getAllTokenInfos();
if (result.error) {
  console.error("Error:", result.error.readableMsg);
  return;
}
const tokens = result.value;
// Do something with the tokens
Copy

Retrieves the complete builder configuration including all deployments.

This returns the parsed builder section from the YAML, filtered to include only the current deployment. Use this to access order-level metadata.

Examples

const result = builder.getBuilderConfig();
if (result.error) {
  console.error("Config error:", result.error.readableMsg);
  return;
}
const config = result.value;
// Do something with the config
Copy

Composes the final Rainlang code with all bindings and scenarios applied.

This method updates scenario bindings from current field values and composes the Rainlang code ready to be displayed on the UI.

Side Effects

Updates the internal scenario bindings before composition.

Examples

const result = await builder.getComposedRainlang();
if (result.error) {
  console.error("Composition error:", result.error.readableMsg);
  return;
}
const rainlang = result.value;
// Do something with the rainlang
Copy

Gets the active deployment's configuration including fields, deposits, and tokens.

This is the primary method for accessing deployment-specific settings that define what inputs are needed from the user. The configuration drives UI generation.

Configuration Structure

• fields - Input fields requiring user configuration
• deposits - Token deposits with amounts and presets
• selectTokens - Tokens that users must choose addresses for
• deployment - Underlying order and scenario configuration

Examples

const result = builder.getCurrentDeployment();
if (result.error) {
  console.error("Error:", result.error.readableMsg);
  return;
}
const deployment = result.value;
// Do something with the deployment
Copy

Gets metadata for the currently active deployment.

Instance method that returns name and description for the deployment selected during initialization.

Examples

const result = builder.getCurrentDeploymentDetails();
if (result.error) {
  console.error("Error:", result.error.readableMsg);
  return;
}
const details = result.value;
// Do something with the details
Copy

Retrieves detailed token information from YAML configuration or blockchain.

This function first checks the YAML for cached token data (decimals, name, symbol). If any information is missing, it queries the blockchain to fetch the complete details. This hybrid approach minimizes RPC calls while ensuring accurate data.

Network Selection

The RPC endpoint is determined by the deployment's order network configuration.

Examples

// Get token info (may query blockchain)
const result = await builder.getTokenInfo("weth");
if (result.error) {
  console.error("Token error:", result.error.readableMsg);
  return;
}
const tokenInfo = result.value;
// Do something with the tokenInfo
Copy

Gets metadata for a specific deployment by key.

Convenience method that extracts details for a single deployment without parsing all deployments.

Examples

const result = await getDeploymentDetail(dotrainYaml, "mainnet-order");
if (result.error) {
  console.error("Not found:", result.error.readableMsg);
  return;
}
const detail = result.value;
// Do something with the detail
Copy

Gets metadata for all deployments defined in the configuration.

This static method extracts name and description for each deployment, useful for building deployment selection interfaces with rich descriptions.

Examples

const result = await getDeploymentDetails(dotrainYaml);
if (result.error) {
  console.error("Error:", result.error.readableMsg);
  return;
}

// key is the deployment key
// value is the deployment metadata
for (const [key, value] of result.value) {
  const {
    // name is the deployment name
    // description is the deployment description
    name,
    description,
    // short_description is the deployment short description (optional)
    short_description,
  } = value;
}
Copy

Lists all available builder deployment keys from a dotrain YAML file.

This function parses the builder section of the YAML frontmatter to extract deployment keys that can be used to initialize a builder instance. Use this to build deployment selectors in your UI.

Examples

const dotrain = `
builder:
  deployments:
    mainnet-order:
      name: "Mainnet Trading"
    testnet-order:
      name: "Test order"
`;

const result = await RaindexOrderBuilder.getDeploymentKeys(dotrain);
if (result.error) {
  console.error("Error:", result.error.readableMsg);
  return;
}
const deploymentKeys = result.value;
// Do something with the deploymentKeys
Copy

Extracts order-level metadata from a dotrain configuration.

This static method allows checking order details without creating a builder instance, useful for displaying order information before deployment selection.

Required Fields

The YAML must contain:

• builder.name - Order display name
• builder.description - Full order description
• builder.short-description - Brief summary (optional but recommended)

Examples

const result = await getOrderDetails(dotrainYaml);
if (result.error) {
  console.error("Error:", result.error.readableMsg);
  return;
}
const details = result.value;
// Do something with the details
Copy

Creates a new builder instance for managing a specific deployment configuration.

This is the primary initialization function that sets up the builder context for a chosen deployment. The instance tracks field values, deposits, token selections, and provides methods for generating order transactions.

State Management

The callback function receives a serialized state string on every change, enabling auto-save functionality or state synchronization across components.

Examples

// Basic initialization
const result = await RaindexOrderBuilder.newWithDeployment(dotrainYaml, "mainnet-order");
if (result.error) {
  console.error("Init failed:", result.error.readableMsg);
  return;
}
const builder = result.value;

// With state persistence
const result = await RaindexOrderBuilder.newWithDeployment(
  dotrainYaml,
  "mainnet-order",
  (serializedState) => {
    localStorage.setItem('orderState', serializedState);
  }
);
if (!result.error) {
  const builder = result.value;
  // Use builder instance...
}
Copy