Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 2.75 KB

README.md

File metadata and controls

70 lines (50 loc) · 2.75 KB
Raw

Amaru

Amaru is a Cardano node client written in Rust. It is an ambitious project which aims to bring more diversity to the infrastructure operating the Cardano network.

Getting Started

Warning

Amaru is still in an exploratory phase. Our development strategy favors early integration of components, so that progress is instantly visible, even though features might be limited or incomplete.

Installing

cargo build --release

Running (demo)

  1. Import a ledger snapshot:
cargo run --release -- import \
  --date 68774372.36f5b4a370c22fd4a5c870248f26ac72c0ac0ecc34a42e28ced1a4e15136efa4 \
  --snapshot 68774372-36f5b4a370c22fd4a5c870248f26ac72c0ac0ecc34a42e28ced1a4e15136efa4.cbor \
  --out ledger.db
  1. Setup observability backends:
docker-compose -f monitoring/jaeger/docker-compose.yml up
  1. Run the node:
AMARU_DEV_LOG=error cargo run --release -- daemon \
  --peer-address=127.0.0.1:3000 \
  --network=preprod

Tip

Replace --peer-address with your Cardano node peer address. It can be either a local or remote node (i.e. any existing node relay).

Monitoring

See monitoring/README.md.

Going further

Amaru is the integration point of several other projects / repositories. Amongst them, we find in particular:

Repository Purpose
txpipe/pallas Hosts many Rust primitives and building blocks for the node already powering tools like Dolos. In particular, the networking and serialization logic.
pragma-org/ouroboros Rust libraries/building blocks to implement an Ouroboros (Praos & Genesis) consensus.
pragma-org/uplc A highly performant UPLC parser and CEK machine.

⛵ Roadmap | 📐 Contributing | Discord Discord