Anoma

This is an implementation of the Anoma protocol, whose specs can be found here.

Docs

• Contributors documentation
• Specification
• Developer Docs (Coming Soon™)
• User Docs (Coming Soon™)

Following Development

Work is merged into base on a bi-weekly (once every two weeks) schedule.

Development can be followed in multiple ways:

1. Issues are put into the project overview
   • This is a good way to see what work is assigned and the various
     views into how goals are being met
2. What's Cooking on Anoma
3. Research Forums
   • This is good for seeing discussions on the direction of Anoma
   • The architecture posts
     in particular are a practical vision for how the codebase's
     architecture will evolve. Around two of these get posted per week
4. Issues and pull requests
   • This is good for viewing new issues and work coming in, but the
     other views are typically a better way to view this

Dependencies

To have a working Anoma Node the following dependencies are required:

1. cmake
2. Erlang version OTP 27 or higher
3. Elixir version 1.17.0 or higher
4. zig
5. rust version of 1.76.0 or newer

• rustup is an easy way to satisfy this.

6. protobuf

• Along with mix escript.install hex protobuf

OSX

brew install cmake
brew install elixir
brew install zig
brew install protbuf

Linux

All the dependencies can be grabbed from your distro's package manager.

Installation

To install the dependencies as well as Anoma run:

mix deps.get
mix escript.install hex protobuf
mix compile

To start an Anoma instance run one of these:

iex -S mix # starts an interactive shell
mix run --no-halt # starts a non-interactive shell

See the Contributing section for how to get the best use of the interactive shell.

Further see the Known issues section if you encounter an issue.

Contributing

Please read the contributor's guide for in depth details about the codebase.

Known Issues

(Mix) Could not compile dependency :enacl

For some versions of OSX (and Linux), our enacl package may have compilation issues.

To get around it please run

git checkout mariari/no-libsodium
mix clean
mix deps.get
mix compile

could not compile dependency :cairo, "mix compile"

The rust compiler can be quite picky about our cairo dependencies. This is likely caused by an incompatible rust-toolchain.

To get around it you may have to run a command like:

rustup toolchain add 1.76.0
# for OSX you may try 1.76.0-aarch64-apple-darwin

Once this is had, the Cairo issues should go away.

Git

This codebase follows a git style similar to git or linux.

New code should be based on base, and no attempt to keep it up to sync with main should be had. When one's topic is ready, just submit a PR on github and a maintainer will handle any merge conflicts.

There are bi-weekly releases, so do not be afraid if a maintainer says the PR is merged but it's still open, this just means that it's merged into next or main and will be included in the next scheduled release.

For more information on a smooth git experience check out the git section in contributor's guide

Happy hacking, and don't be afraid to submit patches.