amaru 0.1.2

A Cardano blockchain node implementation
Documentation

Licence Twitter/X Discord

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

make build

Running

[!IMPORTANT] These instructions assume one starts from scratch, and has access to a synced cardano-node on the selected network (e.g. preprod).

To run a local peer, refer to Cardano's developers portal. Make sure your peer listens to port 3001 or adapt the AMARU_PEER_ADDRESS environment variable (e.g. export AMARU_PEER_ADDRESS=127.0.0.1:3002)

  1. Bootstrap the node:
make AMARU_NETWORK=preprod bootstrap
  1. (Optional) Setup observability backends:
docker-compose -f monitoring/jaeger/docker-compose.yml up
  1. Run Amaru:
make AMARU_NETWORK=preprod start

Replace --peer-address with your Cardano node peer address. It can be either a local or remote node (i.e. any existing node relay), and you can even add multiple peers by replicating the option.

[!TIP] To ensure logs are forwarded to telemetry backend, set AMARU_WITH_OPEN_TELEMETRY=true:

make AMARU_NETWORK=preprod AMARU_WITH_OPEN_TELEMETRY=true start

Monitoring

See monitoring/README.md.