Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Requirements

  • Rust stable as pinned by rust-toolchain.toml
  • a Substrate node with WebSocket RPC enabled
  • archival historical state on that node via --state-pruning archive-canonical
  • polkadot-omni-node if you want to run integrations tests or indexing benchmark
  • just for the documented developer command surface

Install The Binary

From crates.io:

cargo install acuity-index

For local development you can also run it directly without installing:

cargo run -- run ./mychain.toml

Build From Source

Common entry points:

just build
just test
just build-release

Install Documentation Tooling

If you want to build this book locally, install mdbook:

cargo install mdbook

Then use:

just book-build
just book-serve