Skip to content

Latest commit

 

History

History
125 lines (102 loc) · 4.34 KB

building-running.md

File metadata and controls

125 lines (102 loc) · 4.34 KB
Raw

Validated: 2020/02/19

Building and Running the Cardano DB Sync Node

The cardano-db-sync node is built and tested to run on Linux. It may run on Mac OS X or Windows but that is unsupported.

Running the db sync node will require Nix and either multiple terminals or a multi terminal emulator like GNU Screen or TMux. Setup IOHK binary cache to avoid several hours of build time.

The db sync node is designed to work with a locally running Cardano Node. The two git repositories need to be checked out so that they are both at the same level. eg:

> tree -L 1
.
├── cardano-db-sync
├── cardano-node

To setup and run db sync node for testnet replace mainnet with testnet in all examples below. These instuction assume than only blocks and transactions for a single blockchain are inserted in the db. If you want to to use a single database for more than one chain, you will need to duplicate config/pgpass and provide a unique db name for each chain (ie mainnet uses cexplorer). An example testnet PGPASSFILE is at config/pgpass-testnet.

Set up and run a local node

Regular users should almost never attempt building and running from the master branch. Instead, they should build and run the latest release tag. The tags can be listed using the git tag command. Pre-release tags (eg things like 12.0.0-preX) should also be avoided in most cases.

git clone https://github.com/input-output-hk/cardano-node
cd cardano-node
git checkout <latest-official-tag> -b tag-<latest-official-tag>
nix-build -A scripts.mainnet.node -o mainnet-node-local
./mainnet-node-local/bin/cardano-node-mainnet

Set up and run the db-sync node

  • Install secp256k1 library as a prerequisite for building with cabal:
./scripts/secp256k1-setup.sh ac83be33d0956faf6b7f61a60ab524ef7d6a473a
# Check ./github/workflows/haskell.yml to validate the git sha above.

# On Linux
sudo make install 

# On OSX
make install
  • with cabal:
git clone https://github.com/input-output-hk/cardano-db-sync
cd cardano-db-sync
PGPASSFILE=config/pgpass-mainnet scripts/postgresql-setup.sh --createdb
git checkout <latest-official-tag> -b tag-<latest-official-tag>

cabal build cardano-db-sync
PGPASSFILE=config/pgpass-mainnet cabal run cardano-db-sync -- \
    --config config/mainnet-config.yaml \
    --socket-path ../cardano-node/state-node-mainnet/node.socket \
    --state-dir ledger-state/mainnet \
    --schema-dir schema/

to find cardano-db-sync executable location use:

find . -name cardano-db-sync -executable -type f
./dist-newstyle/build/x86_64-linux/ghc-8.10.4/cardano-db-sync-12.0.0/build/cardano-db-sync/cardano-db-sync
  • with nix:
git clone https://github.com/input-output-hk/cardano-db-sync
cd cardano-db-sync
git checkout <latest-official-tag> -b tag-<latest-official-tag>
nix-build -A cardano-db-sync -o db-sync-node
PGPASSFILE=config/pgpass-mainnet scripts/postgresql-setup.sh --createdb
PGPASSFILE=config/pgpass-mainnet db-sync-node/bin/cardano-db-sync \
    --config config/mainnet-config.yaml \
    --socket-path ../cardano-node/state-node-mainnet/node.socket \
    --state-dir ledger-state/mainnet \
    --schema-dir schema/

Run two chains with a single PostgreSQL instance

By running two cardano-nodes and using two databases within a single PostgresSQL instance it is possible to sync two (or more chains).

The two nodes might be run in separate terminals using:

nix-build -A scripts.mainnet.node -o mainnet-node-remote && ./mainnet-node-remote

and

nix-build -A scripts.testnet.node -o testnet-node-remote && ./testnet-node-remote

and then the two db-sync process run as:

PGPASSFILE=config/pgpass-mainnet scripts/postgresql-setup.sh --createdb
PGPASSFILE=config/pgpass-mainnet ./cardano-db-sync-exe \
    --config config/mainnet-config.yaml \
    --socket-path ../cardano-node/state-node-mainnet/node.socket \
    --state-dir ledger-state/mainnet \
    --schema-dir schema/

and

PGPASSFILE=config/pgpass-testnet scripts/postgresql-setup.sh --createdb
PGPASSFILE=config/pgpass-testnet ./cardano-db-sync-exe \
    --config config/testnet-config.yaml \
    --socket-path ../cardano-node/state-node-testnet/node.socket \
    --state-dir ledger-state/testnet \
    --schema-dir schema/