CompressRail docs

Run guide

Prerequisites

  • The Daml SDK 3.5.x toolchain (via DPM), for building and running the Daml model.
  • Node.js, for the off-ledger client and the demo/landing/docs sites.

Build the Daml model

cd daml
dpm build

Start a local Canton sandbox

deploy/sandbox.sh

This starts a local Canton sandbox with the CompressRail DAR loaded and the JSON Ledger API exposed on :7575 by default. It runs without authentication — do not expose it to a network.

Run the off-ledger client's tests

cd app
npm install
npm test

With the sandbox running, the live end-to-end checks can also run:

E2E_LEDGER_URL=http://localhost:7575 npm run e2e

The multi-node checks run the cycle across participant nodes — two firms on two nodes, and a three-firm ring across three nodes with the operator on its own. They need the nodes configured — the variables are listed in the test files — and are skipped otherwise:

npm run e2e:crossnode
npm run e2e:threenode

Run the demo

With the sandbox running:

cd demo
npm install
npm run dev

The demo consumes the app package as a local dependency, so it drives the same client the tests exercise — not a separate mock.