Skip to content

pragma-org/amaru

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

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=yes:

make AMARU_NETWORK=preprod AMARU_WITH_OPEN_TELEMETRY=yes start

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/uplc A highly performant UPLC parser and CEK machine.

Roadmap | 📐 Contributing | Discord Discord

About

A fully open source node client for Cardano, written in Rust

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages