axelar-core

The axelar-core app based on the Cosmos SDK is the main application of the axelar network. This repository is used to build the necessary binaries and docker image to run a core node.

How To Build

Note: For a release build, checkout the release tag via git checkout vX.Y.Z first.

Execute make build to create the axelard binary in the ./bin folder.

Creating docker images

To create a regular docker image for the node, execute make docker-image. This creates the image axelar/core: latest.

To create a docker image for debugging (with delve), execute make docker-image-debug. This creates the image axelar/core-debug:latest.

Smart contracts bytecode dependency

In order to run/build the project locally we need to import the bytecode from gateway smart contracts.

  1. Find the required version of the bytecode here contract-version.json
  2. Download that version from the axelar-cgp-solidity releases. Example: Bytecode-v4.3.0
  3. Unzip the json files under contract-artifacts/
  4. Run make generate to generate x/evm/types/contracts.go

Download and Verify Binary

Before interacting with the axelar network, ensure you have the correct axelard binary and that it's verified:

  1. Download the Binary and Signature File:

    • Go to the Axelar Core releases page.
    • Download the axelard binary for your operating system and architecture.
    • Also, download the corresponding .asc signature file.

  2. Import Axelar's Public Key:

    • Run the following command to import the public key: 
      curl https://keybase.io/axelardev/pgp_keys.asc | gpg --import

  3. Trust the Imported Key:

    • Enter GPG interactive mode: 
      gpg --edit-key 5D9FFADEED11FA5D
    • Type trust then select option 5 to trust ultimately.

  4. Verify the Binary:

    • For example, for version v0.34.3, use: 
      gpg --verify axelard-darwin-amd64-v0.34.3.asc axelard-darwin-amd64-v0.34.3
    • A message indicating a good signature should appear, like: 
      Good signature from "Axelar Network Devs <eng@axelar.network>" [ultimate]

Interacting with a local node

With a local (dockerized) node running, the axelard binary can be used to interact with the node. Run ./bin/axelard or ./bin/axelard <command> --help after building the binaries to get information about the available commands.

Show API documentation

Execute GO111MODULE=off go install -u golang.org/x/tools/cmd/godoc to ensure that godoc is installed on the host.

After the installation, execute godoc -http ":{port}" -index to host a local godoc server. For example, with port 8080 and godoc -http ":8080" -index, the documentation is hosted at http://localhost:8080/pkg/github.com/axelarnetwork/axelar-core. The index flag makes the documentation searchable.

Comments at the beginning of packages, before types and before functions are automatically taken from the source files to populate the documentation. See https://blog.golang.org/godoc for more information.

CLI command documentation

For the full list of available CLI commands for axelard see here

Test tools

Dev tool dependencies, such as moq and goimports, can be installed via make prereqs. Make sure they're on available on your PATH.

Bug bounty and disclosure of vulnerabilities

See the Axelar documentation website.