Skip to content
Open Relay Protocol Open Relay Protocol ORP

Quickstart

This page gets you from clone to a running demo. Commands are taken from the repository README.

Install

Section titled “Install”
Terminal window
npm install

Run the tests

Section titled “Run the tests”

The adversarial suite attacks the blindness invariant directly. The handoff cites 146 tests, each annotated with what it proves.

Terminal window
npm test

Two scans in the suite are worth calling out:

  • a board-view scan, which asserts that what the board can observe is limited to opaque tags and sealed payloads, and
  • a dgram wire-byte scan, which inspects raw datagram bytes to confirm no plaintext contents, keys, or unsealed signaling leak onto the wire.

Run the demo (in-process)

Section titled “Run the demo (in-process)”
Terminal window
npm run demo

Run the demo against real transport

Section titled “Run the demo against real transport”
Terminal window
npm run demo:real

This exercises the protocol over real transport adapters rather than the in-process stand-ins. See the production-transport gap for what a deployer must supply.

Type-check

Section titled “Type-check”
Terminal window
npm run typecheck

Source: repository README (install, test, demo, demo:real, typecheck), tests/ (the two scans). TODO: confirm exact script names and the test count against package.json and README (see OPEN-QUESTIONS.md).