Skip to main content

@effectstream/orchestrator

Package: @effectstream/orchestrator · Source

A multi-chain local development environment for EffectStream. One CLI starts every dependency a template needs - Postgres / PgLite, Hardhat, contracts, Bitcoin Core, Midnight node + indexer + proof server, Cardano-side services, Avail node + light client, NEAR sandbox, Celestia, plus the EffectStream sync + runtime + batcher - in the right order, with health checks.

  • One CLI that starts every dependency a template needs: DB, chains, sync, runtime, batcher.
  • Dependency-graph aware: runs in parallel where it can, sequential where it must.
  • Disable any chain with DISABLE_EVM=true, DISABLE_BITCOIN=true, ...
  • Used by every template in this repo and by the E2E runner.

Install​

bun add @effectstream/orchestrator
# or
npm install @effectstream/orchestrator

Standalone usage​

The orchestrator is mostly invoked as a CLI from a template's repo root:

# Start every process defined in orchestrator.config.ts (or .json)
bun packages/build-tools/orchestrator/src/cli.ts start

# Show what's running and the health of each
bun packages/build-tools/orchestrator/src/cli.ts status

# Stop everything
bun packages/build-tools/orchestrator/src/cli.ts stop

Each process is declared in an OrchestratorConfig object: its command, working directory, environment, the ports/endpoints to watch for readiness, and which other processes it depends on. Then the orchestrator builds the dependency graph and runs them in parallel where possible.

import type { OrchestratorConfig } from "@effectstream/orchestrator/config";

export const config: OrchestratorConfig = {
  processes: [
    {
      name: "pglite",
      command: ["bun", "run", "@effectstream/db/start-pglite"],
      readiness: { tcp: { port: 5432 } },
    },
    {
      name: "hardhat",
      command: ["bun", "run", "hardhat", "node"],
      readiness: { http: { url: "http://127.0.0.1:8545" } },
    },
    {
      name: "deploy-contracts",
      command: ["bun", "scripts/deploy.ts"],
      dependsOn: ["hardhat"],
    },
    // …
  ],
};

Common chain launchers ship as subpath scripts you can compose: ./launch-pglite, ./launch-evm, ./launch-bitcoin, ./launch-cardano, ./launch-midnight, ./launch-avail, ./launch-near. Each wraps a pinned binary from a package under packages/binaries/ (e.g. @effectstream/npm-midnight-node, @effectstream/bitcoin-core, @effectstream/near-sandbox) with sensible defaults.

Tip: Disable chains you don't need with env vars: DISABLE_EVM=true, DISABLE_BITCOIN=true, DISABLE_MIDNIGHT=true, etc. Same flags work for the orchestrator and e2e/runner.ts.

CLI reference​

orchestrator start   [config]    Start processes (daemonised, exposes HTTP API)
orchestrator status              Show process status
orchestrator restart <name>      Restart a named process
orchestrator stop    [name]      Stop a named process, or all
orchestrator list    [config]    List processes without starting
orchestrator silence <name...>   Suppress terminal output for named processes
orchestrator unsilence <name...> Resume terminal output
orchestrator logs   [name...]    Follow background daemon log files

Global flags:
  --port <n>        Orchestrator API port (default: 4747)

Inside EffectStream​

Every template under templates/ defines an orchestrator.config.ts (or .json) and starts dev with one command. The E2E runner at e2e/runner.ts is the same machinery, serialised across nine chain suites.

Key subpath exports​

  • @effectstream/orchestrator/config - OrchestratorConfig, ProcessConfig types.
  • @effectstream/orchestrator/resolve-package - resolve a package's bin to an absolute path (used by launcher scripts).
  • @effectstream/orchestrator/launch-pglite, ./launch-evm, ./launch-bitcoin, ./launch-cardano, ./launch-midnight, ./launch-avail, ./launch-near - opinionated launcher scripts for each chain.
  • @effectstream/orchestrator/wait-tcp, ./wait-http - readiness-check helpers.

Examples​

  • Templates: every directory under templates/ ships a working orchestrator config.
  • E2E: e2e/ drives the orchestrator under the hood.

Runnable: test/examples.test.ts.