Pre-Requisite

cardano-db-sync

If you intend to run cardano-submit-api or cardano-explorer-api, you’ll need to connect to either a running a cardano-node or a postgresql database filled with data from cardano-db-sync.

Instructions on how to build cardano-node and cardano-db-sync can be found here.

Alternatively, docker images are also provided for these components and available on DockerHub:

$ docker pull inputoutput/cardano-node:latest
$ docker pull inputoutput/cardano-db-sync:latest

See also docker-compose.yaml for an example setup wiring these components together.

Stack Build

:warning: Make sure you have the following system dependencies installed and available:

  • libsystemd-dev

  • libz-dev

  • libpq-dev

  • libssl-dev

Using Haskell Stack to build the project:

stack build

Alternatively, you can build only a subset of the available executables. In particular:

stack build cardano-explorer-api
stack build cardano-submit-api

for building the explorer API and the transaction submission API respectively.

Cabal Build

:warning: Make sure you have the following system dependencies installed and available:

  • libsystemd-dev

  • libz-dev

  • libpq-dev

  • libssl-dev

Using Cabal to build the project:

cabal build