Skip to content

Overview

The documentation here uses instructions from IOHK repositories as a foundation, with additional info which we can contribute to where appropriate. Note that not everyone needs to build each component. You can refer to architecture to understand and qualify which components you want to run.

Components⚓︎

For most Pool Operators, simply building cardano-node should be enough. Use the below to decide whether you need other components:

graph TB A(Need to interact with
HD Wallets with keys
saved locally?) B(Need to explore
blockchain locally?) C(Manage pool-ops,
asset operation tasks
easily?) D(Create Custom Assets?) E(Monitor node
using Terminal UI) O(Node) P(PostgREST) Q(DBSync) R(Wallet) S(CNTools) T(Rest) U(GraphQL) V(OfflineMetadataTools) X(gLiveView) O --x E --x X O --x C --x S O --x D D --x S D --x V O --x B B --x P --x Q B --x T --x Q B --x U --x Q O --x A --x R

We strongly prefer use of PostgREST over Rest/GraphQL components due to performance, security, simplicity, control and most importantly - consistency benefits. Please refer to official documentations if you're interested in GraphQL or Cardano-Rest components instead.

Note

The instructions are intentionally limited to stack/cabal to avoid wait times/availability of nix/docker files on a rapidly developing codebase - this also helps us prevent managing multiple versions of instructions.